关键词

Jira自动化项目管理AI助手ScrumIssue跟踪

使用说明

项目简介

Jira MCP Server 是一个基于 Model Context Protocol (MCP) 构建的应用后端，旨在为支持 MCP 协议的 AI 助手提供与 Jira 项目管理工具集成的能力。通过此服务器，AI 助手可以自动化执行 Jira 中的任务，例如创建和管理 issue、跟踪 sprint 进度、以及进行项目和看板管理。

主要功能点

  • Issue 管理: 创建、更新、搜索和检索 Jira issue。
  • Sprint 跟踪: 支持基本的 sprint 跟踪功能。
  • 项目和看板管理: 提供项目和看板管理能力。
  • API 密钥认证: 使用 API 密钥进行请求认证，保障安全性。
  • 标准化 MCP 协议: 采用标准化的 MCP 协议与 AI 助手进行交互。

安装步骤

  1. 克隆仓库: 
    git clone https://github.com/Warzuponus/mcp-jira.git
cd mcp-jira
  2. 配置环境变量: 复制 '.env.example' 文件并重命名为 '.env'，然后根据您的 Jira 和服务器配置修改以下环境变量： 
    JIRA_URL=https://your-domain.atlassian.net  # 您的 Jira 域名
[email protected]      # 您的 Jira 用户名 (邮箱)
JIRA_API_TOKEN=your_api_token             # 您的 Jira API Token
PROJECT_KEY=PROJ                         # 您的 Jira 项目 Key
DEFAULT_BOARD_ID=1                       # 您的 Jira 默认看板 ID (数字)
API_KEY=your_secure_api_key              # 用于 MCP 认证的 API 密钥，请设置一个安全的密钥
    注意: 您需要在 Jira 中生成 API token，并替换 'your_api_token'。'API_KEY' 用于 MCP 客户端连接服务器时的身份验证，请务必设置为安全的密钥。

服务器配置

MCP 客户端需要配置以下 JSON 格式信息以连接到 Jira MCP Server：

{
  "server name": "JiraMCP Server",
  "command": "uvicorn",
  "args": [
    "mcp_jira.server:app",
    "--host",
    "0.0.0.0",
    "--port",
    "8000"
  ],
  "description": "Jira MCP Server for AI project management",
  "auth": {
    "type": "apiKey",
    "key": "X-API-Key",
    "in": "header"
  }
}

配置参数说明:

  • 'server name': 服务器名称，可以自定义，例如 "JiraMCP Server"。
  • 'command': 启动服务器的命令，这里使用 'uvicorn' (FastAPI 推荐的 ASGI 服务器)。
  • 'args': 启动命令的参数列表：
    • '"mcp_jira.server:app"': 指定 FastAPI 应用的位置 ('mcp_jira/server.py' 文件中的 'app' 实例)。
    • '"--host", "0.0.0.0"': 指定服务器监听的 IP 地址为 '0.0.0.0' (监听所有网络接口)。
    • '"--port", "8000"': 指定服务器监听的端口为 '8000'。
  • 'description': 服务器描述，可以自定义。
  • 'auth': 认证配置，用于 MCP 客户端进行身份验证：
    • 'type': 认证类型，这里使用 'apiKey' (API 密钥认证)。
    • 'key': API 密钥的 header 名称，Jira MCP Server 期望在 header 中名为 'X-API-Key' 的字段中找到 API 密钥。
    • 'in': API 密钥的位置，这里设置为 'header' (HTTP Header)。

启动服务器:

在项目根目录下，运行以下命令启动 Jira MCP Server：

uvicorn mcp_jira.server:app --reload --host 0.0.0.0 --port 8000

添加 '--reload' 参数可以在代码更改时自动重启服务器，方便开发调试。正式环境部署时请移除 '--reload' 参数。

基本使用方法

  1. 配置 MCP 客户端: 在您的 AI 助手的 MCP 客户端配置中，填入上述 服务器配置 JSON 信息。
  2. 发送 MCP 请求: AI 助手将根据 MCP 协议，向 Jira MCP Server 发送 JSON-RPC 请求，以执行 Jira 相关操作。例如，AI 助手可以请求创建 issue、搜索 issue 或执行 sprint 计划等功能。
  3. API 密钥认证: 确保 MCP 客户端在每个请求的 HTTP Header 中包含 'X-API-Key' 字段，其值为您在 '.env' 文件中配置的 'API_KEY'。

示例 MCP 请求 (创建 Issue):

以下是一个创建 Issue 的 MCP 请求示例 (JSON 格式)，MCP 客户端需要根据 MCP 协议规范构造类似的请求发送到服务器：

{
  "jsonrpc": "2.0",
  "method": "process_request",
  "params": {
    "function": "create_issue",
    "parameters": {
      "summary": "Implement feature Y",
      "description": "Detailed description for feature Y",
      "issue_type": "Story",
      "priority": "Medium"
    },
    "context": {
      "conversation_id": "conv-456",
      "user_id": "user-456",
      "api_key": "your_secure_api_key"  // 请替换为您的 API_KEY
    },
    "resource_type": "issue"
  },
  "id": "req-123"
}

请参考仓库代码和 MCP 协议文档，了解更多可用的功能和请求参数。

信息

分类

开发者工具

访问项目