MCP-DOCKER-Atlassian 中文文档

基于 Docker 的 Atlassian 集成设置用于与 VS Code 的 Copilot MCP 扩展一起使用。

此仓库包含配置和脚本，可轻松在 Docker 容器中运行 MCP Atlassian 服务器，通过 Model Context Protocol 访问 Confluence 和 Jira 资源。

注意：从上游项目继承的 MyPy 类型检查问题已解决。类型检查系统现已完全正常工作，并且所有检查均通过。

先决条件

• Docker 已安装并运行
• Visual Studio Code 安装了 Copilot Chat 扩展
• Atlassian 云账户及 API令牌
  • 在 https://id.atlassian.net/manage-profile/security/api-tokens 生成令牌
  • 安全保存令牌，创建后无法再次查看

快速开始

1. 克隆仓库：

   git clone https://github.com/shane-reaume/MCP-DOCKER-Atlassian.git
   cd MCP-DOCKER-Atlassian
   

2. 设置你的凭证： 复制示例环境文件并编辑：

   cp .env.example .env
   # 编辑 .env 文件以输入你的 Atlassian 凭证
   

   注意：请不要在 .env 文件中使用引号

3. 使脚本可执行：

   chmod +x *.sh
   

4. 启动 MCP 服务器：

   ./start-mcp.sh
   

   服务器将在 http://localhost:9001/sse 启动

   停止 MCP 服务器：

   ./stop-mcp.sh
   

5. 配置 VS Code： 在你的 VS Code settings.json 中添加：

   "mcpManager.servers": [
     {
       "name": "Atlassian-MCP",
       "type": "sse",
       "url": "http://localhost:9001/sse",
       "enabled": true
     }
   ]
   

6. 停止服务器以完成：

   ./stop-mcp.sh
   

可用脚本

• start-mcp.sh：构建 Docker 镜像并启动容器
• stop-mcp.sh：停止运行中的容器
• check-mcp.sh：诊断工具，用于验证服务器是否正常运行
• cleanup.sh：移除旧的容器和镜像
• update-remote.sh：帮助管理 Git 远程仓库
• mcp-manager.sh：其他管理命令

可用 MCP 命令

连接后，你可以使用以下命令：

• @mcp confluence_search "搜索词"
• @mcp confluence_get_page "页面标题"
• @mcp jira_get_issue "PROJECT-123"
• @mcp jira_search "project = PROJECT AND status = '进行中'"

故障排除

1. 启动问题：

   • 确保 Docker 已正确安装并运行
   • 检查是否有足够的权限执行脚本
   • 查看输出日志以获取更多信息

2. 连接问题：

   • 确认服务器已成功启动并在指定地址运行
   • 检查网络配置，确保没有防火墙阻止访问
   • 验证 .env 文件中的配置是否正确无误

环境变量

MCP 服务器通过以下环境变量进行配置：

• PORT：设置服务监听的端口，默认为 9001
• API_KEY：用于身份验证的 API 令牌
• DB_URL：数据库连接 URL，格式如 jdbc:mysql://localhost:3306/database

基于

此项目基于以下资源和库：

• 官方 MCP 文档
• Docker 官方文档
• VS Code 扩展开发指南

如需进一步支持或遇到问题，请参考相关文档或联系项目维护人员。