使用说明
Confluence MCP Server(DataCenter版)
Confluence DataCenter/Server环境Model Context Protocol(MCP)服务器。AI代理Confluence的空间、页面、用户和搜索功能。
📋 概要
MCP服务器Confluence DataCenter/Server的,之17个主要API提供以下功能:
- 📄 页面管理: 作成・読取・更新・削除の完全なCRUD操作
- 🔍 高级搜索: CQL(Confluence Query Language)强大的搜索功能
- 🏷️ 标签管理:内容分类整理功能
- 👥 用户管理:用户搜索和信息检索功能
- 🏢 空间管理:获取和管理空间信息
- 📝 Markdown变换: Confluence页面和Markdown相互转换
🎯 支持的版本
- ✅ 汇流数据中心/服务器 - REST API v1 + Basic验证(用户名和密码)
- ❌ 汇流云 -此版本不支持
📚 API一覧(全17个)
📄 页面管理API(5个)
| API名称|参数|返回值|使用场景|
|-------|----------|--------|----------|
| confluence_get_pages | spaceKey, limit, expand | 页面对象数组|搜索并浏览空间中的页面|
| confluence_get_page_by_id | pageId, expand | 页面对象ID获取个别页面的详细信息
| confluence_create_page | spaceKey, title, content, type | 已创建页信息|创建新文档文章|
| confluence_update_page | pageId, title, content, version | 已更新页信息|更改页内容、标题|
| confluence_delete_page | pageId | 删除成功消息|删除不需要的页面|
🔍 搜索标签管理API(3个)
| API名称|参数|返回值|使用场景|
|-------|----------|--------|----------|
| confluence_search_content | cql, limit, expand | 搜索结果列表CQL(Confluence Query Language)高级搜索
| confluence_get_content_labels | contentId | 标签信息数组|确认赋予页面的标签|
| confluence_add_content_label | contentId, labels | 添加结果|页面分类标记|
🏢 空间管理API(2个)
| API名称|参数|返回值|使用场景|
|-------|----------|--------|----------|
| confluence_get_spaces | limit, expand | 空间对象数组|查看可用空间列表|
| confluence_get_space_by_id | spaceKey, expand | 空间详细信息ID的个别信息取得
👥 用户管理API(3个)
| API名称|参数|返回值|使用场景|
|-------|----------|--------|----------|
| confluence_get_current_user |无|当前用户信息|验证用户的信息确认|
| confluence_get_user_by_id | userId | 用户详细信息ID的个别信息取得
| confluence_get_users | username, limit | 用户搜索结果|按用户名搜索、浏览|
📝 Markdown变换API(4个)⭐特征机能
| API名称|参数|返回值|使用场景|
|-------|----------|--------|----------|
| confluence_page_to_markdown | pageId, filePath | 文件路径Markdown转换保存为文件
| confluence_markdown_to_page | filePath, spaceKey, parentPageId | 创建页面ID | Markdown从文件新建页面
| confluence_update_page_from_markdown | pageId, filePath | 更新结果Markdown在文件中更新现有页
| confluence_export_space_to_markdown | spaceKey, outputDir | 导出结果Markdown格式导出
�主要特点
DataCenter版专用最适化
- REST API v1対応: DataCenter/Server特定于环境
- Basic认证:通过用户名密码进行身份验证
- 高性能:不需要API简化了调用的高效实现
高级搜索功能
- CQL(汇流查询语言):支持强大的搜索查询
- 灵活的过滤:在作者、日期、空间等中进行详细检索
Markdown统合机能
- 双方向変換: Confluence ⇔Markdown の相互变换
- 批量导出:汇总整个空间Markdown添加
- 元数据保留:适当保留页面信息
📦 安装设置
前提条件
- Node.js 18以上
- Confluence DataCenter/Server 访问权限
- 有效用户名密码
1.项目准备
# リポジトリのクローン
git clone <repository-url>
cd confluence_mcp_server
# 依存関係のインストール
npm install
# TypeScriptのビルド
npm run build
2.环境设定
# 環境設定ファイルの作成
cp .env.example .env
.env编辑文件:
# Confluence DataCenter/Server の設定
CONFLUENCE_DOMAIN=localhost:8090
CONFLUENCE_AUTH_TYPE=basic
CONFLUENCE_USERNAME=your-username
CONFLUENCE_PASSWORD=your-password
CONFLUENCE_BASE_URL=http://localhost:8090/rest/api
3. VS Code MCP设定
VS Code在配置文件中添加:
Basic对于身份验证
{
"mcp": {
"confluence-mcp-server": {
"command": "node",
"args": ["path/to/confluence_mcp_server/build/index.js"],
"env": {
"CONFLUENCE_DOMAIN": "localhost:8090",
"CONFLUENCE_AUTH_TYPE": "basic",
"CONFLUENCE_USERNAME": "your-username",
"CONFLUENCE_PASSWORD": "your-password"
}
}
}
}
Token对于身份验证
{
"mcp": {
"confluence-mcp-server": {
"command": "node",
"args": ["path/to/confluence_mcp_server/build/index.js"],
"env": {
"CONFLUENCE_DOMAIN": "localhost:8090",
"CONFLUENCE_AUTH_TYPE": "token",
"CONFLUENCE_TOKEN": "your-personal-access-token"
}
}
}
}
注意: CONFLUENCE_BASE_URL通常不需要。否则,将自动使用以下默认值:
- Basic认证:
http://{CONFLUENCE_DOMAIN}/rest/api - Token认证:
https://{CONFLUENCE_DOMAIN}/wiki/api/v2
CONFLUENCE_BASE_URL需要时:
- 使用自定义路径(例如通过代理)时
- 要指定与默认值不同的端点
💡 使用例
基本操作
确认空间
「利用可能なConfluenceスペース一覧を表示してください」
查找页面
「タイトルに'API'を含むページをCQL検索で探してください」
创建页面
「DOCスペースに『開発ガイドライン』というタイトルで新しいページを作成してください」
高级功能
CQL使用搜索
「スペースがTESTで、最終更新が2024年以降のページを検索してください」
标签管理
「ページID 12345 に『重要』と『開発』のラベルを追加してください」
Markdown变换
「ページID 67890 をMarkdownファイルに変換して、./docs/guide.md として保存してください」
注意: confluence_page_to_markdown 和 confluence_markdown_to_page 那么,文件路径是绝对路径中所述修改相应参数的值。
- ✅ 正确示例:
C:\Users\username\Documents\guide.md - ❌ 错误示例:
./docs/guide.md(相对路径)
批量导出
「DOCスペース全体を C:\Users\username\backup\DOC_space にMarkdown形式でエクスポートしてください」
🔧 开发测试
运行测试
# 全17APIの動作テスト
cd test
./confluence_datacenter_17_apis.bat
在开发模式下运行
npm run dev
⚠️ 故障排除
常见问题和解决办法
验证错误
- ✅ 验证用户名和密码
- ✅ 确认帐户有效性
- ✅ 检查域设置
权限错误
- ✅ 检查空间页的访问权限
- ✅ 确认编辑权限
- ✅ 管理者権限の必要性确认
连接错误
- ✅ Confluence服务器启动状态确认
- ✅ 检查网络连接
- ✅ 确认端口号(通常为8090)
- ✅ SSL证书问题(在开发环境中
NODE_TLS_REJECT_UNAUTHORIZED=0)
📊 技术仕样
支持
- REST API:
/rest/apiv1端点 - 认证方式: Basic验证(用户名和密码)
- 内容格式:存储格式、Markdown
- 検索言语:CQL(汇流查询语言)
性能优化
- DataCenter专用高效API呼叫
- 最小网络通信量
- 正确的错误处理
- 优化内存使用
🤝 贡献・开発参加
- 存储库分叉
- 创建特征分支
- 实施更改
- 运行测试
- 提交拉式请求
📄 许可证
MIT License - 了解更多信息LICENSE浏览文件
📈 版本历史记录
- v3.0.1:稳定版本版本(支持17API)
- v2.1.0: CQL添加搜索、标签管理和用户搜索功能(支持17API)
- v2.0.0版本: DataCenter版初回发布(支持13API)