使用说明
MCP汇流服务器
用于与Atlassian Confluence集成的TypeScript MCP(模型上下文协议)服务器。
特性
- 🔧 自动配置:交互式设置,无需手动配置文件
- 🔐 安全认证:带自动续订功能的基于API令牌的身份验证
- 🔍 完整的搜索功能:基于CQL的搜索和全文搜索
- 📄 页面和空间管理:访问Confluence的内容和结构
- 🚀 STDIO传输:运行标准输入/输出以兼容MCP
- ⚡ 速率限制:针对API过载的内置保护
- ✍️ 写入操作:使用Atlassian标记格式验证创建和更新页面
安装
选项1:NPX(推荐)
使用MCP Confluence服务器的最简单方法是使用npx。配置会自动保存在您的主目录中,并在运行之间持续存在。
先决条件
- 安装 Node.js (版本18或更高)
设置步骤
-
添加到Claude桌面配置:
-
打开您的Claude Desktop配置文件:
- 视窗:
%APPDATA%\Claude\claude_desktop_config.json - macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - Linux:
~/.config/Claude/claude_desktop_config.json
- 视窗:
-
将“汇流”条目添加到您的
mcpServers配置:
{ "mcpServers": { "confluence": { "command": "npx", "args": ["@aiondadotcom/mcp-confluence-server"] } } } -
-
重新启动克劳德桌面:
- 完全关闭克劳德桌面
- 在Windows上,也在任务管理器中结束Claude进程(它在后台运行)
- 重新启动克劳德桌面
-
配置您的Confluence凭据:
- MCP服务器将在首次使用时提示您输入凭据
- 您需要在Confluence中创建一个API令牌:
- 首选 大西洋API代币
- 点击“创建API令牌”
- 给它起个名字(例如“MCP”)
- 复制令牌
- AI将要求:
- 您的Confluence URL(例如。,
https://your-company.atlassian.net) - 您的电子邮件地址
- 您的API代币
- 您的Confluence URL(例如。,
- 配置将自动保存在
~/.mcp-confluence-config.json
就是这样!服务器现在将与Claude Desktop一起工作,您的配置将在会话之间保持不变。
选项2:手动安装(替代方案)
适合喜欢手动设置的用户的替代安装方法:
-
全局安装软件包:
npm install -g @aiondadotcom/mcp-confluence-server -
为服务器创建一个目录:
mkdir C:\mcp-confluence cd C:\mcp-confluence -
创建批处理文件
start-server.bat:@echo off mcp-confluence-server -
添加到Claude桌面配置 (
%APPDATA%\Claude\claude_desktop_config.json):{ "mcpServers": { "confluence": { "command": "C:\\mcp-confluence\\start-server.bat", "cwd": "C:\\mcp-confluence", "args": [], "env": {} } } } -
初始设置:
- 启动克劳德桌面
- 使用
setup_confluence配置Confluence凭据的工具 - 这
config.json将保存在C:\mcp-confluence并在运行之间持续
方案3:地方发展
git clone https://github.com/AiondaDotCom/mcp-confluence.git
cd mcp-confluence
npm install
npm run build
用法
MCP与NPX集成
使用npx将服务器添加到MCP配置中:
{
"mcpServers": {
"confluence": {
"command": "npx",
"args": ["@aiondadotcom/mcp-confluence-server"],
"env": {}
}
}
}
地方发展设置
- 复制
mcp.json到您的MCP配置目录 - 或者将服务器添加到现有的MCP配置中:
{
"mcpServers": {
"confluence": {
"command": "/path/to/mcp-confluence/start-server.sh",
"cwd": "/path/to/mcp-confluence",
"args": [],
"env": {}
}
}
}
直接启动(用于测试)
# NPX
npx @aiondadotcom/mcp-confluence-server
# Local development
./start-server.sh
配置
服务器通过以下方式自动处理配置 setup_confluence 工具。配置保存在 ~/.mcp-confluence-config.json 并在会话之间持续。
自动设置
当你第一次使用服务器时,它会提示你:
- 您的Confluence URL(例如。,
https://your-company.atlassian.net) - 您的电子邮件地址
- 您的API代币
配置会自动验证并保存。
手动配置(可选)
您还可以手动创建 ~/.mcp-confluence-config.json:
{
"confluenceBaseUrl": "https://your-company.atlassian.net",
"confluenceEmail": "your.email@example.com",
"confluenceApiToken": "Your-API-Token"
}
MCP工具
配置
setup_confluence:设置或更新配置action: "setup":初始配置action: "update_token":续订令牌action: "validate":验证配置
搜索
search_confluence:基于CQL的搜索search_pages:页面中的全文搜索get_recent_pages:最近修改的页面
内容
get_page:检索特定页面get_space:空间信息list_spaces:所有可用空间
写入操作
create_page:创建新的Confluence页面- ⚠️ 重要:内容必须采用Atlassian标记格式!
update_page:更新现有Confluence页面- ⚠️ 重要:内容必须采用Atlassian标记格式!
Atlassian标记格式示例
h1. Heading
*bold text*
_italic text_
{info}This is an info box{info}
{panel}This is a panel{panel}
{code}code block{code}
MCP资源
confluence://spaces:所有可用空间confluence://recent-pages:最近修改的页面confluence://user:当前用户信息
配置存储
配置会自动保存在 ~/.mcp-confluence-config.json 在您的主目录中。这确保了配置在会话之间保持不变,并适用于npx。无需手动编辑。
创建API令牌
- 首选https://id.atlassian.com/manage-profile/security/api-tokens
- 点击“创建API令牌”
- 为令牌命名一个描述性名称
- 复制令牌(只显示一次)
- 配置服务器时使用令牌
发展
# Development mode
npm run dev
# Build
npm run build
# Tests
npm test
# Linting
npm run lint
故障排除
令牌问题
服务器会自动检测过期或无效的令牌,并提示您续订。
配置问题
删除 ~/.mcp-confluence-config.json 并重新启动服务器以进行重新配置。
API错误
检查:
- 您对Confluence实例的权限
- 基本URL的有效性
- 您的网络连接
标记格式错误
如果在创建或更新页面时遇到错误:
- 确保内容采用Atlassian标记格式,而不是Markdown
- 这些工具将自动检测常见的Markdown语法,并提供有用的错误消息
- 请参阅上面的Atlassian标记格式示例
NPM包
此服务器发布为 @aiondadotcom/mcp-confluence-server 关于NPM。
- 包裹: https://www.npmjs.com/package/@aiondadotcom/mcp融合服务器
- 仓库:https://github.com/AiondaDotCom/mcp-confluence
安装选项
- NPX(无需安装):
npx @aiondadotcom/mcp-confluence-server - 全球安装:
npm install -g @aiondadotcom/mcp-confluence-server - 本地安装:
npm install @aiondadotcom/mcp-confluence-server
许可证
麻省理工学院