项目简介

mcp-jira 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在为大型语言模型 (LLM) 应用提供与 Jira 问题跟踪系统集成的能力。它允许 LLM 通过标准化的 MCP 协议，调用工具来创建和读取 Jira 工单，从而扩展 LLM 在软件开发和项目管理领域的应用场景。

主要功能点

创建 Jira 工单: 允许 LLM 客户端通过调用 'create_jira_ticket' 工具，在指定的 Jira 项目中创建新的工单。
读取 Jira 工单详情: 允许 LLM 客户端通过调用 'read_jira_ticket' 工具，获取指定 Jira 工单的描述信息。

安装步骤

安装 Python 包: 在项目根目录下，使用 'uv pip' 或 'pip' 安装项目依赖。推荐使用 'uv pip' 以获得更快的安装速度。
```
uv pip install .
```
或
```
pip install .
```

服务器配置

MCP 客户端需要配置以下 JSON 格式信息才能连接到 mcp-jira 服务器。

{
  "server_name": "jira",
  "command": "python",
  "args": ["-m", "mcp_jira"],
  "env": {
    "JIRA_URL": "<你的Jira组织URL>",  // 例如: "https://your-org.atlassian.net"
    "JIRA_USER_EMAIL": "<你的Jira用户邮箱>", // 你的Jira账号邮箱
    "JIRA_API_TOKEN": "<你的Jira API Token>" // 从 https://id.atlassian.com/manage-profile/security/api-tokens 获取
  }
}

配置参数说明:

'server_name': 服务器名称，这里设置为 "jira"。
'command': 启动服务器的命令，通常为 'python'。
'args': 传递给 'python' 命令的参数，使用 '-m mcp_jira' 来运行 'mcp_jira' 包中的 'init.py' 文件，该文件启动 MCP 服务器。
'env': 环境变量配置，用于连接 Jira API。
- 'JIRA_URL': 必填，你的 Jira 组织 URL，例如 'https://your-org.atlassian.net'。请替换为你的实际 URL。
- 'JIRA_USER_EMAIL': 必填，你的 Jira 用户邮箱地址。请替换为你的实际邮箱。
- 'JIRA_API_TOKEN': 必填，Jira API Token。你需要访问 https://id.atlassian.com/manage-profile/security/api-tokens 创建并获取 API Token。请替换为你获取的 Token。 请务必妥善保管你的 API Token，避免泄露。

注意: 请确保在运行 MCP 客户端之前，已经正确设置了上述环境变量。

基本使用方法

启动 MCP Jira 服务器: MCP 服务器会在客户端连接时自动启动，无需手动运行。
配置 MCP 客户端: 在你的 MCP 客户端中，配置上述 JSON 信息，客户端将根据配置连接到 mcp-jira 服务器。

调用工具: 客户端连接成功后，可以调用以下工具与 Jira 进行交互：

'create_jira_ticket': 用于创建 Jira 工单。需要提供 'summary' (工单摘要), 'description' (工单描述), 'project_id' (Jira 项目 ID), 'issue_type' (工单类型) 等参数。

{
  "tool_name": "create_jira_ticket",
  "parameters": {
    "summary": "Bug in feature X",
    "description": "Detailed description of the bug",
    "project_id": "PROJECT1",
    "issue_type": "Bug"
  }
}

'read_jira_ticket': 用于读取 Jira 工单描述。需要提供 'ticket_id' (Jira 工单 ID) 参数。

{
  "tool_name": "read_jira_ticket",
  "parameters": {
    "ticket_id": "PROJECT-123"
  }
}

请参考 'src/mcp_jira/server.py' 文件中工具函数的文档字符串 (docstring) 获取更详细的参数说明和使用示例。

关键词

项目简介

主要功能点

安装步骤

服务器配置

基本使用方法

信息