Confluence MCP 服务器

一个基于 FastMCP 的服务器，提供与 Confluence REST API 的无缝集成，从而能够以编程方式访问 Confluence 空间、页面和内容搜索功能。

主要特性

• 空间管理: 列出和筛选 Confluence 空间
• 页面操作: 检索和管理页面内容
• 搜索功能: 执行 CQL (Confluence 查询语言) 搜索
• 空间导航: 列出特定空间内的所有页面
• 身份验证: 安全的基于 API 令牌的访问

系统要求

• Python 3.8+
• pip (Python 包管理器)
• 具有 API 访问权限的活动 Confluence 实例
• 有效的 Confluence API 令牌

安装

通过 Smithery 安装

要通过 Smithery 为 Claude Desktop 自动安装 confluence-mcp-server：

npx -y @smithery/cli install @MahithChigurupati/confluence-mcp-server --client claude

手动安装

1. 克隆存储库

   git clone https://github.com/MahithChigurupati/Confluence-MCP-Server.git
   cd Confluence-MCP-Server
   

2. 设置虚拟环境 (推荐)

   python -m venv venv
   source venv/bin/activate  # 在 macOS/Linux 上
   # 或
   .\venv\Scripts\activate  # 在 Windows 上
   

3. 安装依赖项

   pip install -r requirements.txt
   

配置

1. 创建环境变量文件

   cp .env.example .env
   

2. 配置环境变量

   CONFLUENCE_BASE_URL=https://your-instance.atlassian.net/wiki/rest/api
   USERNAME=your.email@company.com
   API_TOKEN=your-api-token-here
   

3. 获取 Confluence API 令牌

   1. 访问 Atlassian API 令牌
   2. 点击 "创建 API 令牌"
   3. 输入一个有意义的标签 (例如，"MCP 服务器访问")
   4. 立即复制生成的令牌 (它不会再次显示)

使用指南

启动服务器

python confluence.py

可用的 API 方法

1. 列出空间

response = await list_spaces(
    query="engineering",  # 可选: 按名称筛选空间
    limit=25,            # 可选: 要返回的最大空间数
    start=0             # 可选: 分页的起始索引
)

2. 获取页面内容

response = await get_page_content(
    page_id="123456",   # 必需: Confluence 页面 ID
    version=2           # 可选: 特定版本号
)

3. 搜索内容

response = await search_content(
    query="project plan",    # 必需: 搜索查询
    space_key="TEAM",       # 可选: 将搜索限制在特定空间
    limit=50,               # 可选: 最大结果数
    start=0                 # 可选: 起始索引
)

4. 列出空间中的页面

response = await list_pages_in_space(
    space_key="TEAM",       # 必需: 空间键
    limit=100,             # 可选: 要返回的最大页面数
    start=0               # 可选: 起始索引
)

与 MCP 客户端集成

Claude Desktop 配置

{
  "mcpServers": {
    "confluence": {
      "command": "python path",
      "args": ["/path/to/Confluence-MCP-Server/confluence.py"]
    }
  }
}

位置: ~/.claude/claude_desktop_config.json (macOS/Linux) 或 %USERPROFILE%\.claude\config.json (Windows)

Cursor 配置

{
  "mcpServers": {
    "confluence": {
      "command": "python path",
      "args": ["/path/to/Confluence-MCP-Server/confluence.py"]
    }
  }
}

使用 which python 查找 python 路径

在克隆的存储库中使用 pwd 获取路径。不要忘记在最后添加 confluence.py。

位置: ~/.cursor/mcp.json (macOS/Linux) 或 %USERPROFILE%\.cursor\config.json (Windows)

错误处理

常见错误代码及其含义：

• 401: 无效的 API 令牌或凭据
• 403: 权限不足
• 404: 资源未找到
• 429: 超过速率限制

故障排除

1. 连接问题

   • 验证 CONFLUENCE_BASE_URL 格式
   • 检查网络连接
   • 确认 API 令牌有效性

2. 身份验证错误

   • 确保 USERNAME 与 Atlassian 帐户电子邮件匹配
   • 验证 API_TOKEN 是否已正确复制
   • 检查 .env 文件中是否存在特殊字符

3. 权限错误

   • 确认用户具有所需的 Confluence 权限
   • 验证空间和页面访问权限

支持

对于问题和功能请求，请在存储库的问题跟踪器中创建一个 issue。

许可证

MIT 许可证。 有关完整条款，请参见 LICENSE 文件。