项目简介

Confluence MCP服务器是一个基于Model Context Protocol (MCP) 构建的应用后端，旨在为LLM客户端提供Confluence知识库的上下文信息。通过此服务器，LLM可以检索Confluence页面和博客文章的内容，从而增强LLM在处理与Confluence文档相关任务时的能力。

主要功能点

Confluence 内容检索: 提供检索和获取Confluence页面和博客文章内容的功能。
Prompt支持: 预置了用于检索Confluence页面和博客文章的Prompt模板，方便LLM客户端调用。
MCP协议兼容: 遵循Model Context Protocol标准，可以与任何兼容MCP协议的LLM客户端进行通信。
易于安装和配置: 通过npm进行全局安装，并通过环境变量进行Confluence API密钥等配置。
支持多种客户端: 可以与Zed编辑器通过插件集成，也可以通过MCP Inspector等通用MCP客户端进行交互。

安装步骤

安装 npm 包: 打开终端，运行以下命令全局安装 'mcp-confluence' npm包：

npm install -g mcp-confluence

服务器配置

为了让MCP客户端（如Zed编辑器或MCP Inspector）连接到Confluence MCP服务器，您需要提供服务器的启动配置信息。以下是一个JSON格式的配置示例，通常在MCP客户端的设置中进行配置。

{
  "server_name": "confluence-context-server",
  "command": "node",
  "args": [
    "node_modules/mcp-confluence/dist/index.js"
  ],
  "env": {
    "API_TOKEN": "YOUR_CONFLUENCE_API_TOKEN",  // 替换为您的Confluence API令牌
    "DOMAIN_NAME": "YOUR_CONFLUENCE_DOMAIN.atlassian.net", // 替换为您的Confluence域名，例如 example.atlassian.net
    "EMAIL": "YOUR_CONFLUENCE_EMAIL" // 替换为您的Confluence账户邮箱
  }
}

配置参数说明:

'server_name': 服务器的名称，可以自定义，用于在客户端中标识该服务器。
'command': 启动服务器的命令，这里使用 'node' 运行 JavaScript 代码。
'args': 传递给 'node' 命令的参数，指向 'mcp-confluence' 包的入口文件。
'env': 环境变量配置，用于Confluence API的身份验证：
- 'API_TOKEN': 您的 Confluence API 令牌。您需要在您的Atlassian账户中创建API令牌。
- 'DOMAIN_NAME': 您的 Confluence 域名。
- 'EMAIL': 您的 Confluence 账户邮箱。

获取Confluence API Token:

登录您的Atlassian账户。
访问：https://id.atlassian.com/manage-profile/security/api-tokens
点击 "Create API token"，创建并复制您的API令牌。

基本使用方法

配置环境变量: 确保您已根据上述 "服务器配置" 中的说明，设置了 'API_TOKEN', 'DOMAIN_NAME', 和 'EMAIL' 环境变量。
配置MCP客户端: 在您的MCP客户端（例如Zed编辑器或MCP Inspector）中，添加上述JSON配置信息，以连接到Confluence MCP服务器。
使用Prompt: 在MCP客户端中，您可以使用以下Prompt来检索Confluence内容：
- 'confluence-page': 通过页面ID检索Confluence页面内容。需要提供 'pageId' 参数。
- 'blog-post': 通过博客文章ID检索Confluence博客文章内容。需要提供 'blogId' 参数。
例如，在Zed编辑器中，您可以使用 '/confluence-page pageId=12345' 或 '/blog-post blogId=67890' 这样的斜杠命令来调用相应的Prompt。

注意: 此服务器目前仅实现了Prompt功能，资源 (Resources) 和工具 (Tools) 功能尚未实现。

关键词

项目简介

主要功能点

安装步骤

服务器配置

基本使用方法

信息