🚀 MCP 阿特拉斯服务器指南
本指南将帮助你顺利配置并使用 MCP 阿特拉斯服务器来管理你的 Confluence 和 Jira 项目，涵盖安装、使用、开发调试等多方面内容。
🚀 快速开始
安装与配置
使用包管理器安装
你可以使用 npm 或 Yarn 来安装 mcp-atlassian：
npm install mcp-atlassian --save
或者使用 Yarn：
yarn add mcp-atlassian
创建配置文件
在项目的根目录下创建一个 .env 文件，并添加以下配置内容：
CONFLUENCE_URL=你的阿特拉斯网址
CONFLUENCE_USERNAME=你的用户名
CONFLUENCE_TOKEN=你的 API 令牌
JIRA_URL=你的 Jira 网址
JIRA_USERNAME=你的用户名
JIRA_TOKEN=你的 API 令牌
启动服务器
安装和配置完成后，使用以下命令启动服务器：
npx mcp-atlassian
✨ 主要特性
MCP 阿特拉斯服务器功能
- 过滤资源：仅显示用户活跃交互的阿特拉斯空间和 Jira 项目。
- 支持协议：
confluence://{space_key}：访问 Confluence 空间jira://{project_key}：访问 Jira 项目
可用工具
| 工具 | 描述 |
|---|---|
confluence_search |
使用 CQL 搜索 Confluence 内容 |
confluence_get_page |
获取特定 Confluence 页面的内容 |
confluence_get_page_children |
获取特定 Confluence 页面的子页面 |
confluence_get_page_ancestors |
获取特定 Confluence 页面的父页面 |
confluence_get_comments |
获取特定 Confluence 页面的评论 |
confluence_create_page |
创建新的 Confluence 页面 |
confluence_update_page |
更新现有的 Confluence 页面 |
confluence_delete_page |
删除现有的 Confluence 页面 |
jira_get_issue |
获取特定 Jira 问题的详细信息 |
jira_search |
使用 JQL 搜索 Jira 问题 |
jira_get_project_issues |
获取特定 Jira 项目的全部问题 |
jira_create_issue |
在 Jira 中创建新的问题 |
jira_update_issue |
更新现有的 Jira 问题 |
jira_delete_issue |
删除现有的 Jira 问题 |
jira_get_transitions |
获取特定 Jira 问题的可用状态转换 |
jira_transition_issue |
将 Jira 问题过渡到新状态 |
jira_add_worklog |
在 Jira 问题中添加工作日志 |
jira_get_worklog |
获取 Jira 问题的工作日志条目 |
jira_link_to_epic |
将问题链接到史诗任务 |
jira_get_epic_issues |
获取与特定史诗任务相关联的所有问题 |
📦 安装指南
本地开发环境搭建
如果你需要进行开发和调试，可以按照以下步骤搭建本地开发环境：
- 克隆仓库：
git clone https://github.com/your-username/mcp-atlassian.git cd mcp-atlassian - 安装依赖项：
npm install - 启动开发服务器：
npm run dev
调试工具
使用 mcp-debug 包来调试你的 MCP 服务器：
npm install mcp-debug --save-dev
💻 使用示例
基础用法
搜索 Confluence 内容
mcp-atlassian confluence_search --query "你的搜索词"
创建新 Jira 问题
mcp-atlassian jira_create_issue --projectKey "项目标识" --issueType "任务" --summary "问题摘要" --description "详细描述"
📚 详细文档
高级配置
设置代理服务器
在 .env 文件中添加以下内容以设置代理：
HTTP_PROXY=http://代理地址:端口
HTTPS_PROXY=https://代理地址:端口
启用日志记录
在 .env 文件中启用详细日志：
DEBUG=true
常见问题
如何处理认证失败？
- 检查你的用户名和令牌是否正确。
- 确保令牌具有足够的权限。
无法连接到阿特拉斯或 Jira？
- 检查网络连接。
- 确认目标 URL 正确无误。
如何调试工具命令？
- 使用
--verbose选项在命令行中启用详细输出：mcp-atlassian <command> --verbose
文档扩展
如需更多高级功能和配置选项，请参考完整的开发者文档： https://github.com/your-username/mcp-atlassian/wiki
🔧 技术细节
安全注意事项
- 保护令牌：不要在代码中明文存储 API 令牌，建议使用环境变量。
- 限制访问：确保阿特拉斯和 Jira 的访问权限符合安全策略。
通过以上指南，你可以顺利配置并使用 MCP 阿特拉斯服务器来管理你的 Confluence 和 Jira 项目。如果有任何问题或建议，请随时查阅文档或与社区联系。