AI导哈

Jira自然语言查询工具

一个基于TypeScript的Jira MCP服务器，提供自然语言查询和创建Jira问题的功能，支持与VS Code等LLM IDE集成。

  • by phinaliumz
  • TypeScript
  • 本地部署
  • 更新于
在 GitHub 查看 phinaliumz/jira-mcp

使用说明

Jira MCP服务器

该项目在TypeScript中实现了一个模型上下文协议（MCP）服务器，用于与Jira Cloud交互。它公开了使用自然语言（由OpenAI提供支持）查询和创建Jira问题的工具，旨在轻松与Visual Studio Code等LLM IDE集成。

特性

  • 使用自然语言查询Jira问题（OpenAI支持的JQL转换）
  • 在任何可访问的项目中创建新的Jira问题
  • 列出当前用户可见的所有Jira项目

先决条件

  • Node.js（建议使用v18+）
  • 拥有API访问权限的Jira云帐户
  • A Jira API代币
  • （可选，但推荐）用于自然语言查询的OpenAI API密钥

设置

  1. 克隆存储库

    git clone https://github.com/phinaliumz/jira-mcp.git
cd jira-mcp

  2. 安装依赖项

    npm install

  3. 配置环境变量

    • 服务器需要以下环境变量：
      • JIRA_API_TOKEN：您的Jira API代币
      • JIRA_BASE_URL：您的Jira Cloud基础URL（例如。， https://your-domain.atlassian.net)
      • JIRA_EMAIL：您的Jira帐户电子邮件
      • OPENAI_API_KEY：您的OpenAI API密钥（用于自然语言查询）
    • 当与VS Code一起使用时，会通过以下方式提示 .vscode/mcp.json.

  4. 构建服务器

    • 在运行之前，您必须构建TypeScript项目：
      npm run build
    • 这将TypeScript源代码编译为JavaScript build/ 目录。

  5. 在VS代码中使用

    • 在VS Code中打开项目。
    • 创建 .vscode/mcp.json 文件-它将提示您输入Jira凭据和OpenAI API密钥，然后使用npm脚本启动服务器。
    • 使用MCP面板访问工具：
      • list-projects：列出所有可访问的Jira项目
      • query-issues：按自然语言获取问题（OpenAI支持的JQL转换）
      • create-issue：创建新问题（指定项目密钥、摘要、描述和可选的问题类型）

示例 .vscode/mcp.json

下面是VS Code集成的示例配置。这将提示您输入Jira凭据和OpenAI API密钥，然后使用npm脚本启动MCP服务器：

{
    "inputs": [
        {
            "type": "promptString",
            "id": "jira-key",
            "description": "Jira API Key",
            "password": true
        },
        {
            "type": "promptString",
            "id": "jira-base-url-key",
            "description": "Jira Base URL"
        },
        {
            "type": "promptString",
            "id": "jira-email-key",
            "description": "Jira Email"
        },
        {
            "type": "promptString",
            "id": "openapi-api-key",
            "description": "OpenAI API Key",
            "password": true
        }
    ],
    "servers": {
        "jira-mcp": {
            "type": "stdio",
            "command": "sh",
            "args": [
                "-c",
                "cd \"${workspaceFolder}\" && npm run start"
            ],
            "env": {
                "JIRA_API_TOKEN": "${input:jira-key}",
                "JIRA_BASE_URL": "${input:jira-base-url-key}",
                "JIRA_EMAIL": "${input:jira-email-key}",
                "OPENAI_API_KEY": "${input:openapi-api-key}"
            }
        }
    }
}

VS代码集成提示

如果你想让你的MCP服务器为任何克隆存储库的人工作，请确保 .vscode/mcp.json 服务器命令使用：

"command": "sh",
"args": [
    "-c",
    "cd \"${workspaceFolder}\" && npm run start"
]

这可确保服务器始终在正确的目录中启动，而不管项目克隆到哪里。 ${workspaceFolder} 被具有打开项目根的VS代码替换。

故障排除

  • 如果您看到“未找到项目”，请检查Jira API令牌、电子邮件和权限。
  • 如果问题创建失败，请确保问题类型存在于您的项目中，并且描述采用Atlassian文档格式（ADF）。
  • 使用 list-projects 用于确认可用项目密钥的工具。
  • 对于自然语言查询，请确保您的OpenAI API密钥已设置且有效。

许可证

麻省理工学院

相关 MCP