mcp-atlassian

🚀 MCP Atlassian 安装与配置

MCP Atlassian 是一款实用的工具，可帮助用户在不同平台上与 Atlassian 的 Confluence 和 Jira 服务进行交互。本指南将详细介绍其安装、配置、使用及相关注意事项。

🚀 快速开始

安装

使用以下命令安装 MCP Atlassian：

uvx mcp-atlassian install

针对不同平台的安装命令如下：

• macOS：

  uvx mcp-atlassian install --platform=darwin
  

• Windows：

  uvx mcp-atlassian install --platform=windows
  

• Linux（支持主流发行版）：

  uvx mcp-atlassian install --platform=linux
  

配置

环境变量配置

在终端或命令提示符中设置以下环境变量：

export MCP_ATLASSIAN_APISecret=your_api_token_here

⚠️ 重要提示

• 云用户：使用 CONFLUENCE_API_TOKEN 和 JIRA_API_TOKEN 环境变量。
• 服务器/数据中心用户：使用 CONFLUENCE_USERNAME、CONFLUENCE_PASSWORD、JIRA_USERNAME 和 JIRA_PASSWORD。

IDE 配置

在你的 IDE 中配置 MCP 服务器：

{
  "mcpServers": {
    "mcp-atlassian": {
      "command": "uvx mcp-atlassian run",
      "args": []
    }
  }
}

📦 安装指南

不同平台安装

• macOS：

  uvx mcp-atlassian install --platform=darwin
  

• Windows：

  uvx mcp-atlassian install --platform=windows
  

• Linux（支持主流发行版）：

  uvx mcp-atlassian install --platform=linux
  

💻 使用示例

资源与工具

资源链接

• confluence://{space_key}：访问 Confluence 空间
• jira://{project_key}：访问 Jira 项目

⚠️ 重要提示

MCP 服务器会根据用户当前互动情况，过滤显示 Confluence 空间和 Jira 项目的可见性。

关键工具

Confluence 工具

• confluence_search：使用 CQL 搜索 Confluence 内容
• confluence_get_page：获取特定页面内容
• confluence_create_page：创建新页面
• confluence_update_page：更新现有页面
• confluence_attach_content：附加内容到页面

Jira 工具

• jira_get_issue：获取特定问题详情
• jira_search：使用 JQL 搜索问题
• jira_create_issue：创建新问题
• jira_update_issue：更新现有问题
• jira_transition_issue：转移问题到新状态
• jira_add_comment：添加问题评论

📚 详细文档

故障排除与调试

常见问题

• 无响应：检查环境变量是否正确设置。
• 认证失败：确保 API 令牌或凭据准确无误。
• 连接超时：验证网络连通性和目标服务状态。

调试工具

使用以下命令启动调试：

uvx mcp-atlassian debug

在 IDE 中配置调试参数：

{
  "mcpServers": {
    "mcp-atlassian-debug": {
      "command": "uvx mcp-atlassian debug",
      "args": []
    }
  }
}

安全

• 保护 API 令牌：避免在代码中明文存储。
• 环境变量安全：确保敏感信息不被意外泄露。
• 更新策略：定期更换 API 令牌以增强安全性。

贡献指南

开发环境设置

安装依赖项：

uvx mcp-atlassian dev-dependencies install

启动开发服务器：

uvx mcp-atlassian dev

提交代码

使用以下命令提交更改：

uvx mcp-atlassian pull-request

📄 许可证

MCP Atlassian 采用 MIT 许可证，具体条款如下：

版权 © [年份] [作者姓名]

准许任何人复制、分发和/或修改本软件，前提是以下条件得到满足：

1. 发行的副本中包含版权声明。
2. 修改版本必须携带版权声明和此许可声明。