Confluence API服务器

一个基于FastMCP的服务器,提供与Confluence REST API的无缝集成,支持程序化访问Confluence空间、页面和内容搜索功能。

  • by MahithChigurupati
  • Python
  • 本地部署
  • 3 星标
  • 更新于
在 GitHub 查看 MahithChigurupati/Confluence-MCP-Server

使用说明

汇流MCP服务器

一个基于FastMCP的服务器,提供与Confluence的REST API的无缝集成,实现对Confluence空间、页面和内容搜索功能的编程访问。

主要特点

  • 空间管理:列出并过滤汇流空间
  • 页面操作:检索和管理页面内容
  • 搜索功能:执行CQL(汇流查询语言)搜索
  • 太空导航:列出特定空间内的所有页面
  • 认证:基于API令牌的安全访问

系统要求

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

安装

通过Smithery安装

通过以下方式自动安装克劳德桌面的汇流mcp服务器 史密瑟里:

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  # On macOS/Linux
    # or
    .\venv\Scripts\activate  # On 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. 访问 大西洋API代币
    2. 点击“创建API令牌”
    3. 输入有意义的标签(例如“MCP服务器访问”)
    4. 立即复制生成的令牌(不会再次显示)

使用指南

启动服务器

python confluence.py

可用的API方法

1.列出空格

response = await list_spaces(
    query="engineering",  # Optional: Filter spaces by name
    limit=25,            # Optional: Maximum number of spaces to return
    start=0             # Optional: Starting index for pagination
)

2.获取页面内容

response = await get_page_content(
    page_id="123456",   # Required: Confluence page ID
    version=2           # Optional: Specific version number
)

3.搜索内容

response = await search_content(
    query="project plan",    # Required: Search query
    space_key="TEAM",       # Optional: Limit search to specific space
    limit=50,               # Optional: Maximum results
    start=0                 # Optional: Starting index
)

4.空间中的列表页面

response = await list_pages_in_space(
    space_key="TEAM",       # Required: Space key
    limit=100,             # Optional: Maximum pages to return
    start=0               # Optional: Starting index
)

与MCP客户端集成

Claude桌面配置

{
  "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)

光标配置

{
  "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. 身份验证错误

    • 确保用户名与Atlassian帐户电子邮件匹配
    • 验证API_TOKEN是否已正确复制
    • 检查.env文件中的特殊字符
  3. 权限错误

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

支持

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

许可证

MIT许可证。看 LICENSE 提交完整条款。