Confluence MCP 服务器

使用说明内容(Markdown格式)

  • 项目简介 该仓库实现了一个 MCP 服务器,利用 Claude Desktop 等 MCP 客户端进行集成,向 LLM 提供 Confluence 相关的资源和工具(例如页面搜索和读取页面内容的能力)。

  • 主要功能点

    • 提供两个工具(Tools):
      • confluence_search:基于 CQL 在 Confluence 中搜索页面
      • confluence_get_page:按页面 ID 获取页面正文(HTML 转文本)
    • 通过 Confluence REST API 获取数据,返回给 MCP 客户端
    • 将 HTML 内容转换为可读文本输出,并附带元数据
    • 使用 StdioServerTransport 以标准输入/输出的方式运行 MCP 服务器
    • 通过环境变量配置 Confluence 的基地址和个人访问令牌(PAT)
    • 服务器具备会话上下文和能力声明,便于与 LLM 进行安全、可扩展的协作
  • 安装步骤

    1. 安装依赖并构建
      • npm install
      • npm run build
    2. 设置环境变量(运行前必须提供)
      • CONFLUENCE_BASE_URL: 你的 Confluence 实例的基 URL,例如 https://your-domain.atlassian.net
      • CONFLUENCE_PAT: 你的 Confluence Personal Access Token
    3. 启动 MCP 服务器
      • node dist/server.js
    4. 将 MCP 客户端(如 Claude Desktop)配置为连接到该服务器(详见“服务器配置”中的示例)
  • 服务器配置(MCP 客户端使用的配置示例,JSON 格式) { "mcpServers": { "confluence": { "command": "node", "args": ["dist/server.js"], "env": { "CONFLUENCE_BASE_URL": "https://your-domain.atlassian.net", "CONFLUENCE_PAT": "your-personal-access-token" } } } }

配置字段说明(简要注释,便于理解)

  • mcpServers: MCP 客户端需要的服务器列表配置

  • confluence: 服务器别名,在客户端连接时使用的标识

  • command: 启动 MCP 服务器的命令,这里使用 node

  • args: 上述命令的参数,指向构建产物 dist/server.js

  • env: 运行时环境变量

    • CONFLUENCE_BASE_URL: Confluence 的基地址
    • CONFLUENCE_PAT: 访问 Confluence 的个人访问令牌
  • 基本使用方法

    1. 按上述安装步骤完成构建并启动服务器
    2. 在 Claude Desktop(或其他 MCP 客户端)中添加连接器,名称可选为 confluence,确保命令和路径正确执行
    3. 测试示例(在对话中使用自然语言触发工具,例如)
      • 页面搜索: 在 Confluence 中检索相关文档
      • 获取页面: 通过页面 ID 获取并阅读正文文本
    4. 如需调整 Confluence 的查询或输出长度,请在工具的参数中进行设置(例如 maxChars 等)
  • 其他注意

    • 该实现需要外部 Confluence 实例和 PAT,请确保权限和 API 访问范围正确配置
    • MCP 协议通过标准输入输出(stdio)进行通信,确保运行环境对标准输入/输出未做改动
    • 构建输出的 dist/server.js 是实际运行的服务器入口

服务器信息