cf-mcp
v1.0.2
Published
Confluence MCP server with attachment download functionality
Readme
Confluence MCP Server
Confluence MCP Server 是一个增强版的 Confluence MCP 工具,提供文档附件下载功能。
功能特性
- 获取页面内容 - 读取 Confluence 页面的完整内容,包括所有附件元数据
- 列出页面附件 - 获取页面内所有附件的详细信息(ID、文件名、大小、下载 URL 等)
- 下载单个附件 - 将指定附件下载到本地文件系统
- 批量下载附件 - 一键下载页面内所有附件到指定目录
安装
npm install配置
- 复制
.env.example为.env:
cp .env.example .env- 编辑
.env文件,填入你的 Confluence 配置:
CONFLUENCE_BASE_URL=https://your-domain.atlassian.net/wiki
[email protected]
CONFLUENCE_API_TOKEN=your-api-token获取 API Token
- 访问 Atlassian API Tokens
- 创建新的 API Token
- 将 Token 复制到
.env文件中的CONFLUENCE_API_TOKEN
使用说明
可用工具
1. confluence_get_page
获取 Confluence 页面内容和附件信息。
参数:
page_id(必需): Confluence 页面 ID
示例:
{
"page_id": "123456789"
}2. confluence_get_page_attachments
列出页面的所有附件。
参数:
page_id(必需): Confluence 页面 IDstart(可选): 分页起始索引,默认 0limit(可选): 返回结果数量,默认 50,最大 100
示例:
{
"page_id": "123456789",
"limit": 100
}3. confluence_download_attachment
下载单个附件到本地。
参数:
attachment_id(必需): 附件 IDsave_path(必需): 本地保存路径
示例:
{
"attachment_id": "att123456789",
"save_path": "/Users/you/Documents/report.pdf"
}4. confluence_download_all_page_attachments
下载页面的所有附件。
参数:
page_id(必需): Confluence 页面 IDsave_directory(可选): 保存目录,默认./downloads
示例:
{
"page_id": "123456789",
"save_directory": "/Users/you/Documents/attachments"
}工作流程示例
完整的附件下载流程
首先获取页面内容,查看有哪些附件:
confluence_get_page(page_id="123456789")或者直接列出所有附件:
confluence_get_page_attachments(page_id="123456789")批量下载所有附件:
confluence_download_all_page_attachments(page_id="123456789", save_directory="./my-attachments")或者下载单个附件:
confluence_download_attachment(attachment_id="att123456789", save_path="./document.pdf")
项目结构
.
├── package.json # 项目依赖配置
├── .env.example # 环境变量示例
├── .gitignore # Git 忽略文件
├── README.md # 项目说明文档
├── src/
│ ├── index.js # MCP 服务器主文件
│ └── confluence-client.js # Confluence API 客户端
├── tools/ # MCP 工具描述文件
│ ├── confluence_get_page.json
│ ├── confluence_get_page_attachments.json
│ ├── confluence_download_attachment.json
│ └── confluence_download_all_page_attachments.json
└── SERVER_METADATA.json # 服务器元数据技术栈
- Node.js
- @modelcontextprotocol/sdk (MCP SDK)
- Axios (HTTP 客户端)
- dotenv (环境变量管理)
许可证
MIT
