使用说明
汇流读取器MCP服务器
一个MCP服务器，允许人工智能助手将Confluence Cloud页面作为标记读取，浏览页面树，下载图像附件，并将内容与本地文档进行比较。
特性
- 获取一个Confluence页面作为适当的GitHub风格的标记（标题、表格、列表、代码块）
- 列出用于递归遍历的子页面
- 按文件名下载图像附件
- 将本地内容与具有统一差异的Confluence页面进行比较
- 支持具有基本身份验证的作用域API令牌
设置
1.获取Confluence API代币
从您的Atlassian帐户创建作用域API令牌： https://support.atlassian.com/confluence/kb/scoped-api-tokens-in-confluence-cloud/
2.设置环境变量
添加到您的shell配置文件(~/.zshrc, ~/.bashrc等等）：
export CONFLUENCE_TOKEN="your_scoped_token"
export CONFLUENCE_EMAIL="your_email@example.com"
export CONFLUENCE_CLOUD_ID="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
重新加载你的shell或打开一个新的终端。
| 变量 | 必填 | 描述 |
|---|---|---|
CONFLUENCE_TOKEN |
是 | 范围限定的API令牌 |
CONFLUENCE_EMAIL |
是 | 电子邮件已绑定到您的Atlassian帐户 |
CONFLUENCE_CLOUD_ID |
是* | 云ID--通过路由 api.atlassian.com |
CONFLUENCE_BASE_URL |
是* | 直接租户URL，例如。 https://your-org.atlassian.net |
*其中之一 CONFLUENCE_CLOUD_ID 或 CONFLUENCE_BASE_URL 是必需的。 CONFLUENCE_CLOUD_ID 是推荐的。
3.添加到MCP配置
{
"mcpServers": {
"confluence-reader": {
"command": "npx",
"args": ["@satiyap/confluence-reader-mcp"]
}
}
}
重新启动MCP主机以获取新服务器。
工具
confluence.fetch_page
通过URL获取单个Confluence页面，并将其内容作为markdown返回。在底部列出任何直接的子页面，以便调用者可以决定下一个要获取的子页面。
| 参数 | 类型 | 说明 |
|---|---|---|
url |
string | 汇流页URL |
confluence.list_children
列出Confluence页面的直接子页面，但不获取其内容。用于在获取单个页面之前发现页面结构。
| 参数 | 类型 | 说明 |
|---|---|---|
url |
string | 汇流页URL |
confluence.fetch_image
按文件名从Confluence页面下载图像附件并将其保存到本地目录。
| 参数 | 类型 | 说明 |
|---|---|---|
url |
string | 汇流页URL |
filename |
string | 附件文件名（例如。 architecture.png) |
destination |
string | 保存图像的本地目录路径 |
confluence.compare
在Confluence页面和本地markdown字符串之间生成一个git风格的统一差异。
| 参数 | 类型 | 说明 |
|---|---|---|
url |
string | 汇流页URL |
localContent |
string | 要比较的本地标记 |
返回一个JSON对象 additions, deletions, totalChanges，以及完整 diff.
支持的URL格式
/wiki/spaces/SPACEKEY/pages/123456789/Page+Title/wiki/pages/viewpage.action?pageId=123456789
安全
- 凭据仅从环境变量中读取，从不在配置文件中传递。
- 使用具有所需最小权限的作用域令牌。
贡献
欢迎捐款。请打开问题或提交拉取请求。
许可证
麻省理工学院
