使用说明

项目简介

MCP Atlassian Integration 是一个 Model Context Protocol (MCP) 服务器，它允许大型语言模型 (LLM) 客户端与 Atlassian Confluence 和 Jira 产品进行交互。通过此集成，LLM 可以访问 Confluence 知识库和 Jira 项目管理数据，从而实现更智能的应用场景。

主要功能点

• Confluence 集成:
  • 搜索 Confluence 内容 (CQL 查询)。
  • 获取 Confluence 页面内容和评论。
  • 创建和更新 Confluence 页面。
• Jira 集成:
  • 获取 Jira issue 详情。
  • 搜索 Jira issue (JQL 查询)。
  • 获取 Jira 项目的所有 issue。
  • 创建、更新和删除 Jira issue。
  • 管理 Jira issue 的工作日志和状态流转。
  • 关联 issue 到 Epic。
• 资源管理:
  • 列出用户活跃的 Confluence 空间和 Jira 项目作为资源。
  • 读取 Confluence 页面和 Jira issue 的内容。
• 工具注册:
  • 提供丰富的 Confluence 和 Jira 工具，供 LLM 客户端调用执行操作。
• 兼容性:
  • 同时支持 Atlassian Cloud 和 Jira Server/Data Center 部署。

安装步骤

1. 使用 uv (推荐):

   • macOS 用户可以使用 'brew install uv' 安装 'uv'。
   • 安装后，无需额外安装步骤，直接使用 'uvx mcp-atlassian' 运行。

2. 使用 PIP:

   • 确保已安装 Python 和 pip。
   • 使用命令 'pip install mcp-atlassian' 安装。

3. 通过 Smithery 安装:

   • 用于 Claude Desktop 自动安装，运行命令 'npx -y @smithery/cli install mcp-atlassian --client claude'。

服务器配置

为了让 MCP 客户端（如 Claude Desktop）连接到 MCP Atlassian 服务器，您需要配置 MCP 服务器的启动命令和参数。以下是 JSON 格式的配置信息示例，请根据您的安装方式选择合适的配置，并替换占位符为您实际的 Confluence 和/或 Jira 凭据。

{
  "mcpServers": {
    "mcp-atlassian": {
      "command": "uvx",  // 或者 "python" (如果使用 pip 安装), 或 "docker run" (如果使用 Docker)
      "args": ["mcp-atlassian"], // 或者 ["-m", "mcp-atlassian"] (如果使用 pip 安装), 或 ["run", "--rm", "-i", "mcp/atlassian"] (如果使用 Docker)
      "env": { // 环境变量配置，根据您要集成的服务填写
        "CONFLUENCE_URL": "https://your-domain.atlassian.net/wiki", // 您的 Confluence Cloud URL
        "CONFLUENCE_USERNAME": "[email protected]", // 您的 Confluence 用户名/邮箱
        "CONFLUENCE_API_TOKEN": "your_confluence_api_token", // 您的 Confluence API Token
        "JIRA_URL": "https://your-domain.atlassian.net", // 您的 Jira Cloud 或 Server/Data Center URL
        "JIRA_USERNAME": "[email protected]", // 您的 Jira Cloud 用户名/邮箱 (仅限 Cloud)
        "JIRA_API_TOKEN": "your_jira_api_token", // 您的 Jira Cloud API Token (仅限 Cloud)
        // 或者，对于 Jira Server/Data Center:
        "JIRA_PERSONAL_TOKEN": "your_jira_personal_access_token" // 您的 Jira Server/Data Center 个人访问令牌
      }
    }
  }
}

基本使用方法

1. 启动 MCP Atlassian 服务器后，在 MCP 客户端中配置上述服务器连接信息。
2. 客户端可以列出 Confluence 空间（'confluence://{space_key}'）和 Jira 项目（'jira://{project_key}'）作为资源进行访问。
3. 客户端可以调用注册的工具，例如 'confluence_search'、'jira_get_issue' 等，来执行 Confluence 和 Jira 的相关操作。
4. 具体工具和资源的使用方法请参考仓库 README 文档。