README
🚀 Confluence MCP 服务器
Confluence MCP 服务器是一个用于与 Confluence Data Center 进行交互的模型上下文协议(MCP)服务器。它提供了一系列实用工具,能让 AI 模型与 Confluence 中的内容进行交互,为数据处理和信息获取提供便利。
✨ 主要特性
此 MCP 服务器为 Confluence 提供了丰富的操作功能:
- 执行 CQL(Confluence 查询语言)搜索,精准定位所需页面。
- 根据 ID 获取页面内容,快速获取指定页面信息。
- 带正文获取页面内容,全面掌握页面详情。
- 根据空间键查找页面,高效筛选特定空间内的页面。
- 根据标题和空间键查找页面,进一步精准定位。
- 创建新页面(可选父页面),灵活构建页面层级。
- 更新现有页面,及时维护页面内容。
- 删除页面,清理不再需要的页面。
📦 安装指南
- 克隆此仓库。
- 安装依赖项:
pip install -r requirements.txt
🛠️ 配置说明
在项目根目录中创建一个 .env 文件,包含以下变量:
CONFLUENCE_API_BASE=http://localhost:8090/rest/api
CONFLUENCE_USERNAME=your_username
CONFLUENCE_PASSWORD=your_password
请根据您的 Confluence 实例调整上述值。
💻 使用示例
运行服务器
开发模式(推荐)
运行 MCP 服务器的正确方式是使用 MCP CLI 工具以开发模式启动。这将启动 MCP 检查器 UI,允许您测试和调试服务器:
mcp dev confluence.py
此方式将在默认情况下在 http://127.0.0.1:6274 启动 MCP 检查器。
直接执行(不推荐)
MCP 服务器设计为与 MCP CLI 工具或集成到 Claude Desktop 中运行。直接使用 Python 执行并不是运行 MCP 服务器的标准方式,但脚本包含测试的备用模式:
python confluence.py
然而,此模式功能有限,仅用于基本测试。
安装在 Claude Desktop
要在 Claude Desktop 中安装服务器:
mcp install confluence.py
📚 详细文档
API 参考
execute_cql_search
在 Confluence 上执行 CQL 查询以搜索页面。 参数:
cql:CQL 查询字符串limit:要返回的结果数量(默认:10)
get_page_content
获取 Confluence 页面的内容。 参数:
pageId:Confluence 页面 ID
get_page_with_body
获取带正文内容的页面。 参数:
pageId:Confluence 页面 ID
find_pages_by_space
根据空间键查找页面。 参数:
spaceKey:Confluence 空间键limit:要返回的最大结果数(默认:10)expand:可选的逗号分隔的扩展属性列表
find_page_by_title
根据标题和空间键查找页面。 参数:
title:页面标题spaceKey:Confluence 空间键
create_page
在 Confluence 中创建新页面。 参数:
title:页面标题spaceKey:Confluence 空间键content:页面内容(HTML 格式)parentId:可选的父页面 ID
update_page
更新现有页面。 参数:
pageId:Confluence 页面 IDcontent:新页面内容(HTML 格式)title:可选的新标题spaceKey:可选空间键(仅在更改空间时需要)
delete_page
删除页面。 参数:
pageId:要删除的页面 ID
Scan to join WeChat group