使用说明

项目简介

MCP JIRA Python 是一个基于 Model Context Protocol (MCP) 的服务器实现,旨在为大型语言模型 (LLM) 客户端(如 Claude Desktop)提供与 Atlassian Jira 集成的能力。通过此服务器,LLM 可以安全地访问和操作 Jira 中的 issues,实现诸如创建、查询、更新和删除 issue,以及添加评论和附件等功能。

主要功能点

  • Jira Issue 管理: 提供全面的 Jira issue 管理工具,包括创建、获取、更新和删除 issue。
  • Issue 搜索: 支持使用 JQL (Jira Query Language) 在指定项目中搜索 issues。
  • 评论与附件: 允许 LLM 向 Jira issue 添加评论,并支持带附件的评论。
  • Issue 链接: 支持创建 issue 之间的关联关系。
  • 用户信息和字段信息: 提供获取 Jira 用户信息和字段列表的功能。
  • Issue 类型和链接类型: 支持检索 Jira issue 类型和 issue 链接类型列表。
  • MCP 协议: 完全实现了 MCP 服务器协议,可以与任何兼容 MCP 协议的客户端进行通信。

安装步骤

  1. 克隆仓库
    git clone https://github.com/Kallows/mcp-jira-python.git
  2. 进入项目目录
    cd mcp-jira-python
  3. 安装 Python 包 使用 'pip' 或 'uv' (根据仓库 'README.md' 推荐) 安装项目依赖和自身。
    pip install .
    uv pip install .

服务器配置

要将此 MCP 服务器与 MCP 客户端(例如 Claude Desktop)连接,您需要在客户端的配置文件中添加服务器配置信息。以下是 Claude Desktop 的 'claude_desktop_config.json' 配置文件示例:

{
  "jira-api": {  // 服务器名称,客户端通过此名称识别和调用
    "command": "uv",  // 启动服务器的命令,这里假设您已安装 uv,也可以使用 python
    "args": [  // 启动命令的参数列表
      "run",  // uv run 命令
      "--directory", "/path/to/mcp-jira-python",  // 请替换为您的 mcp-jira-python 仓库的实际路径
      "src/mcp_jira_python/server.py"  // 服务器脚本的路径
    ],
    "env": {  // 环境变量配置
      "JIRA_HOST": "YOURNAME.atlassian.net",  // 请替换为您的 Jira host 域名
      "JIRA_EMAIL": "[email protected]",  // 请替换为您的 Jira 邮箱地址
      "JIRA_API_TOKEN": "YOURJIRATOKEN"     // 请替换为您的 Jira API Token
    }
  }
}

请注意:

  • 确保将 '/path/to/mcp-jira-python' 替换为您克隆 'mcp-jira-python' 仓库的实际本地路径。
  • 将 'YOURNAME.atlassian.net', '[email protected]', 和 'YOURJIRATOKEN' 替换为您的 Jira 组织和 API 凭据。
  • 修改 'claude_desktop_config.json' 后,务必重启 Claude Desktop 客户端以使配置生效。

基本使用方法

  1. 确保已按照上述步骤配置 MCP 客户端并启动 MCP JIRA Python 服务器。
  2. 在 MCP 客户端中,您应该能够看到名为 'jira-api' 的服务器及其提供的工具列表。
  3. 通过自然语言指示 MCP 客户端(例如 Claude),使用 Jira 工具执行相关任务。例如,您可以要求 Claude "创建一个 Jira issue,项目key是 TEST,概要是 'Bug Report',类型是 'Bug'"。客户端会调用相应的 MCP 工具并返回结果。

信息

分类

开发者工具