Confluence MCP服务器使用说明

项目简介

本项目是一个基于Model Context Protocol (MCP) 的服务器实现，旨在为LLM客户端提供访问和操作Confluence知识库的能力。它通过提供工具，使得LLM能够查询Confluence页面以及获取页面内容，从而扩展LLM在知识检索和文档处理方面的能力。

主要功能点

执行CQL查询 (execute_cql_search): 允许LLM使用Confluence查询语言 (CQL) 搜索Confluence页面。用户可以指定CQL查询语句和返回结果的数量限制。
获取页面内容 (get_page_content): 允许LLM根据Confluence页面ID获取页面的详细内容。

安装步骤

安装Node.js和npm: 确保你的系统已安装Node.js和npm (Node包管理器)。

克隆仓库: 将仓库代码克隆到本地：

git clone https://github.com/KS-GEN-AI/confluence-mcp-server.git
cd confluence-mcp-server

安装依赖: 在项目根目录下运行以下命令安装项目依赖：
```
npm install
```
构建项目: 运行以下命令构建项目：
```
npm run build
```

服务器配置

要将此MCP服务器与MCP客户端（例如Claude Desktop）配合使用，您需要配置客户端以连接到此服务器。以下是一个 'claude_desktop_config.json' 配置文件示例，您需要根据您的实际环境进行修改。

{
  "mcpServers": {
    "Confluence communication server": {  // 服务器名称，可以自定义
      "command": "node",  // 启动服务器的命令，这里使用Node.js
      "args": [  // 启动命令的参数
        "/PATH_TO_THE_PROJECT/build/index.js"  //  指向构建后的服务器入口文件路径，请替换为您的实际路径
      ],
      "env": {  // 环境变量配置
        "CONFLUENCE_URL": "https://XXXXXXXX.atlassian.net/wiki",  // 您的Confluence实例URL，例如：https://your-domain.atlassian.net/wiki，请替换为您的实际URL
        "CONFLUENCE_API_MAIL": "Your email",  //  您的Confluence API 邮箱，用于API身份验证，请替换为您的Atlassian账户邮箱
        "CONFLUENCE_API_KEY": "KEY_FROM: https://id.atlassian.com/manage-profile/security/api-tokens"  // 您的Confluence API 密钥，用于API身份验证，请从Atlassian账户的安全设置中生成并替换
      }
    }
  }
}

配置说明:

'/PATH_TO_THE_PROJECT/build/index.js': 请将此路径替换为您本地仓库 'confluence-mcp-server' 项目中 'build/index.js' 文件的绝对路径。
'CONFLUENCE_URL': 请替换为您的Confluence实例的URL。
'CONFLUENCE_API_MAIL': 请替换为用于访问Confluence API的Atlassian账户邮箱。
'CONFLUENCE_API_KEY': 请替换为您在Atlassian账户安全设置中生成的API密钥。

重要提示:

请确保已正确配置 'CONFLUENCE_URL', 'CONFLUENCE_API_MAIL', 和 'CONFLUENCE_API_KEY' 环境变量，否则服务器将无法连接到您的Confluence实例。
根据您使用的MCP客户端，配置文件的路径和格式可能有所不同。请参考您使用的MCP客户端的文档进行配置。

基本使用方法

启动MCP服务器：无需手动启动，MCP客户端在需要时会自动启动配置的MCP服务器。
在MCP客户端中，当需要查询Confluence信息时，客户端会调用此MCP服务器提供的工具。
LLM可以通过自然语言指令，结合 'execute_cql_search' 和 'get_page_content' 工具来完成Confluence知识库的查询和内容获取任务。具体的工具调用方式取决于您使用的MCP客户端的功能和界面。

例如，在支持工具调用的LLM应用中，您可以指示LLM执行类似 "使用CQL查询Confluence中关于项目A的页面" 的指令，LLM客户端将会调用 'execute_cql_search' 工具，并将查询结果返回给LLM。

关键词