mcp-confluence
by: mouhamadalmounayar
This repository contains the source code for a confluence context server, it provides prompts that can be used as slash commands for clients like Zed Editor, in order to add page contents as context to the AI assistant.
📌Overview
Purpose: The primary goal of the MCP-Confluence framework is to provide a context server for Confluence, enabling users to utilize prompts as slash commands within the Zed environment.
Overview: MCP-Confluence is an early-stage development project that serves as a source code repository for a Confluence context server. Designed to facilitate interactions with Confluence, it includes a set of prompts meant for streamlined access to Confluence pages and blog posts.
Key Features:
-
Slash Commands Integration: Allows users to execute commands through prompts, making interactions with Confluence more efficient and user-friendly.
-
API Key Authentication: Ensures secure access to users' Confluence accounts through required API keys and domain settings, enhancing security during usage.
Mcp-Confluence
Important:
This repository is still in early development stages. More prompts, resources, and tools will be added in the future.
This repository contains the source code for a Confluence context server.
Currently, the server only contains prompts designed to be used as slash commands by Zed.
Installation
npm install -g mcp-confluence
Usage
The following environment variables must be set:
API_KEY
: The API key to authenticate your Confluence account.DOMAIN_NAME
: The domain name of your Confluence account (e.g.,example.atlassian.net
).EMAIL
: The email of your Confluence account.
Example configuration:
"confluence-context-server": {
"command": "node",
"args": [
"node_modules/mcp-confluence/dist/index.js"
],
"env": {
"API_TOKEN": "",
"DOMAIN_NAME": "",
"EMAIL": ""
}
}
Zed
Install the confluence-context-server extension from GitHub.
Then, add these settings to your Zed settings:
"context_servers": {
"confluence-context-server": {
"settings": {
"api_token": ,
"domain_name": ,
"email":
}
}
}
MCP Inspector
You can also use the MCP Inspector to interact with the server.
npm install @modelcontextprotocol/sdk
npx -y @modelcontextprotocol/inspector npx mcp-confluence
Prompts
Confluence Page
- name:
confluence-page
- description: Get a Confluence page by its ID.
- arguments:
pageId
: The ID of the Confluence page.
Blog Post
- name:
blog-post
- description: Get a blog post by its ID.
- arguments:
blogId
: The ID of the blog post.