🚀 MCP Confluence API 项目文档
MCP 是一款专门用于与 Confluence 进行交互的实用工具。它功能强大，支持获取空间信息、页面内容、执行搜索操作，还能创建和更新页面等，为用户在 Confluence 平台上的操作提供了极大便利。
🚀 快速开始
要使用 MCP，你需要先安装 Node.js 和 npm，然后通过以下命令进行安装：
npm install mcp-confluence-api --save
✨ 主要特性
- 支持两种认证方式：Access Token 和用户名密码，满足不同场景的安全需求。
- 提供丰富的操作接口，如获取空间信息、页面内容、搜索功能以及创建和更新页面等。
- 具备错误处理功能，方便开发者捕获和处理异常。
📦 安装指南
要使用 MCP，请先安装 Node.js 和 npm。然后通过以下命令安装：
npm install mcp-confluence-api --save
💻 使用示例
基础用法
配置
MCP 支持两种认证方式：Access Token 和用户名密码。请根据需求选择其中一种配置。
const ConfluenceService = require('mcp-confluence-api');
// 使用 Access Token 认证
const confluenceService = new ConfluenceService({
url: 'https://your-instance.atlassian.com',
accessToken: 'your_access_token'
});
// 或者使用用户名密码认证
const confluenceService = new ConfluenceService({
url: 'https://your-instance.atlassian.com',
username: 'your_username',
password: 'your_password'
});
具体操作
- 获取空间信息
const space = await confluenceService.getSpace('SPACE_KEY');
- 获取页面信息
const page = await confluenceService.getPage('PAGE_ID');
- 通过 Pretty URL 获取页面
const page = await confluenceService.getPageByPrettyUrl('SPACE_KEY', 'PAGE_TITLE');
- 创建页面
const newPage = await confluenceService.createPage({
spaceKey: 'SPACE_KEY',
title: 'Page Title',
content: 'Page Content',
parentId: 'PARENT_PAGE_ID', // 可选
representation: 'storage' // 可选，默认为 'storage'
});
- 更新页面
const updatedPage = await confluenceService.updatePage({
id: 'PAGE_ID',
title: 'Updated Title', // 可选
content: 'Updated Content', // 可选
version: 2, // 页面版本号
representation: 'storage' // 可选，默认为 'storage'
});
- 搜索内容
const results = await confluenceService.searchContent('search query');
- 获取页面详细内容
const content = await confluenceService.getPageContent('PAGE_ID');
📚 详细文档
安全建议
⚠️ 重要提示
- 优先使用 Access Token 认证方式，这样更安全。
- 定期轮换 Access Token。
- 不要在代码中硬编码认证信息。
- 确保
.env文件已添加到.gitignore中。- 在生产环境中使用环境变量或安全的配置管理系统。
- 如果同时配置了两种认证方式，系统会优先使用 Access Token。
注意事项
⚠️ 重要提示
- Access Token 和用户名密码认证方式只能选择其中一种。
- 如果同时配置了两种认证方式，系统会优先使用 Access Token。
- 确保 URL 正确且有效。
- 保持 API 版本与 Confluence 实例版本一致。
错误处理
MCP 提供错误处理功能，可以通过以下方式捕获错误：
try {
// 操作代码
} catch (error) {
console.error('Error:', error);
}
贡献指南
欢迎社区贡献！请访问 GitHub 地址 提交问题和 PR。
📄 许可证
MCP Confluence API 开源项目遵循 MIT 协议。