AI导哈

Confluence MCP服务

一个用于Confluence的模型上下文协议（MCP）服务器，允许AI助手与Confluence数据进行交互。

  • by akashbhardwaj
  • Python
  • 本地部署
  • 更新于
在 GitHub 查看 akashbhardwaj/confluence-mcp

使用说明

汇流MCP服务器

Confluence的模型上下文协议（MCP）服务器，允许AI助手与Confluence数据交互。

Docker快速入门

快速开始使用预构建的Docker镜像：

docker run -d \
  --name confluence-mcp \
  -e JIRA_BASE_URL=https://your-domain.atlassian.net/wiki \
  -e JIRA_API_TOKEN=your-api-key \
  -e JIRA_API_USER=your-email@example.com \
  --restart unless-stopped \
  ghcr.io/akashbhardwaj/confluence-mcp:latest

用您实际的Confluence凭据替换环境变量。请参阅 Docker部署 有关更多详细信息，请参阅第节。

特性

  • 访问Confluence空间、页面和内容
  • 搜索汇流内容
  • 创建、更新和删除页面
  • 使用Confluence API令牌进行身份验证
  • Docker支持，易于部署

先决条件

  • 汇流云实例
  • Confluence API令牌

对于当地发展：

  • Python 3.10+
  • UV用于依赖性管理

设置

  1. 克隆此存储库
  2. 使用UV安装依赖项：
    uv venv
uv pip install -e .
  3. 在shell配置中设置环境变量（例如。， ~/.zshrc 或 ~/.bashrc):
    export JIRA_BASE_URL=https://your-domain.atlassian.net/wiki
export JIRA_API_TOKEN=your-api-key
export JIRA_API_USER=your-email@example.com
export DEBUG=false  # Optional: set to true for debug logging
  4. 重新加载shell配置：
    source ~/.zshrc  # or source ~/.bashrc
  5. 运行服务器：
    python -m src.confluence_mcp.main

配置

服务器需要以下环境变量：

  • JIRA_BASE_URL：您的汇流云URL（例如。， https://your-domain.atlassian.net/wiki)
  • JIRA_API_TOKEN：您的Confluence API令牌
  • JIRA_API_USER：与API令牌关联的电子邮件地址
  • DEBUG：（可选）设置为 true 启用调试日志记录

用法

服务器运行后，您可以配置VS Code设置以使用它：

"mcp": {
    "servers": {
        "Confluence": {
            "url": "http://localhost:3846/sse"
        }
    }
}

可用功能

  • 空间：列出空间，获取空间详细信息
  • 页面：列出、获取、创建、更新和删除页面
  • 搜索：在Confluence上搜索内容

发展

要运行测试，请执行以下操作：

# Run all tests
pytest

# Run with coverage
pytest --cov=src

Docker部署

预构建的Docker镜像可在以下网址获得 ghcr.io/akashbhardwaj/confluence-mcp.

使用预构建图像（推荐）

docker run -d \
  --name confluence-mcp \
  -e JIRA_BASE_URL=https://your-domain.atlassian.net/wiki \
  -e JIRA_API_TOKEN=your-api-key \
  -e JIRA_API_USER=your-email@example.com \
  --restart unless-stopped \
  ghcr.io/akashbhardwaj/confluence-mcp:latest

在当地建设

chmod +x build_docker.sh
./build_docker.sh

docker run -d \
  --name confluence-mcp \
  -e JIRA_BASE_URL=https://your-domain.atlassian.net/wiki \
  -e JIRA_API_TOKEN=your-api-key \
  -e JIRA_API_USER=your-email@example.com \
  --restart unless-stopped \
  confluence-mcp:latest

相关 MCP