Jira API协议服务器

一个为Jira 9.12.14 API实现的模型上下文协议(MCP)服务器,允许AI模型通过定义良好的工具安全地与Jira交互。

  • by andrewyun0403
  • JavaScript
  • 本地部署
  • 更新于
在 GitHub 查看 andrewyun0403/jira-9.12.14-mcp-server

使用说明

Jira 9.12.14 MCP服务器

这是Jira 9.12.14 API的模型上下文协议(MCP)服务器实现。它允许像Claude这样的AI模型通过定义良好的工具安全地与Jira交互。

特性

  • JQL搜索:执行JQL查询以查找Jira中的问题
  • 获取问题:按ID或密钥检索特定问题的详细信息

先决条件

  • Node.js(v16或更高版本)
  • npm或纱线
  • Jira实例
  • Jira API的身份验证凭据

安装

选项1:使用npx(推荐)

使用此MCP服务器的最简单方法是使用npx:

# Create a directory for your configuration
mkdir jira-mcp && cd jira-mcp

# Create .env file with your credentials
cat > .env << EOL
JIRA_API_URL=https://your-domain.atlassian.net
JIRA_AUTH_TOKEN=your-token-here
EOL

# Run the server directly
npx @andrewyun/jira-9-12-14-mcp-server

选项2:手动安装

  1. 克隆存储库
  2. 安装依赖项:
npm install
  1. 构建项目:
npm run build

配置

选项1:.env文件中的环境变量

服务器从 .env 当前目录中的文件。创建一个名为的文件 .env 具有以下设置:

JIRA_API_URL=https://your-domain.atlassian.net
JIRA_AUTH_TOKEN=your-jira-token

您必须在运行服务器的目录中创建此文件。

选项2:MCP JSON环境变量

作为.env文件的替代方案,您可以使用MCP JSON环境变量配置服务器。在中更新您的Claude桌面配置 mcpServers 章节:

{
  "mcpServers": {
    "jira": {
      "command": "node",
      "args": [
        "/ABSOLUTE/PATH/TO/jira-9.12.14-mcp-server/dist/index.js"
      ],
      "env": {
        "MCP_JIRA_API_URL": "https://your-domain.atlassian.net",
        "MCP_JIRA_AUTH_TOKEN": "your-jira-token"
      }
    }
  }
}

使用MCP JSON环境变量意味着您不需要创建.env文件。

环境变量详细信息

  • JIRA_API_URL 或 MCP_JIRA_API_URL:Jira实例的基本URL(例如。, https://your-domain.atlassian.net)
  • JIRA_AUTH_TOKEN 或 MCP_JIRA_AUTH_TOKEN:您的Jira API令牌或个人访问令牌(PAT)

获取Jira API代币

  1. 登录您的Atlassian帐户
  2. 前往帐户设置>安全>创建和管理API令牌
  3. 点击“创建API令牌”
  4. 给它起个名字,比如“MCP服务器”
  5. 将生成的令牌复制到您的 .env 文件或MCP JSON配置

用法

运行服务器

npm start

与Claude for Desktop集成

  1. 打开您的Claude进行桌面应用程序配置,网址为 ~/Library/Application Support/Claude/claude_desktop_config.json (MacOS)或 %AppData%\Claude\claude_desktop_config.json (Windows)
  2. 添加服务器配置:
{
  "mcpServers": {
    "jira": {
      "command": "node",
      "args": [
        "/ABSOLUTE/PATH/TO/jira-9.12.14-mcp-server/dist/index.js"
      ],
      "env": {
        "MCP_JIRA_API_URL": "https://your-domain.atlassian.net",
        "MCP_JIRA_AUTH_TOKEN": "your-jira-token"
      }
    }
  }
}

替换 /ABSOLUTE/PATH/TO/ 使用系统上服务器的实际路径。

使用npx

如果你通过npx安装,你的Claude配置如下:

{
  "mcpServers": {
    "jira": {
      "command": "npx",
      "args": [
        "--yes",
        "@andrewyun/jira-9-12-14-mcp-server"
      ],
      "env": {
        "MCP_JIRA_API_URL": "https://your-domain.atlassian.net",
        "MCP_JIRA_AUTH_TOKEN": "your-jira-token"
      }
    }
  }
}

重要:如果您使用的是MCP JSON环境变量,则不需要 .env 文件。如果您没有使用MCP JSON环境变量,请确保您有 .env 使用npx时,将文件保存在主目录或安装Claude for Desktop的目录中。

可用工具

JQL搜索(mcp_jira_jql_search)

执行JQL查询以查找Jira中的问题。

参数:

  • jql (必填):JQL查询字符串
  • fields (可选):每期要返回的字段列表
  • maxResults (可选):返回的最大结果数
  • startAt (可选):要返回的第一个结果的索引
  • expand (可选):回复中应包含的其他信息

获取问题(mcp_jira_get_issue)

按ID或密钥检索有关特定问题的详细信息。

参数:

  • issueIdOrKey (必填):问题的ID或密钥
  • fields (可选):要包含在响应中的字段列表
  • expand (可选):回复中应包含的其他信息
  • properties (可选):要包含在响应中的属性
  • failFast (可选):是否在错误时快速失败(默认值:false)

故障排除

如果您看到以下错误 JIRA_API_URL environment variable is required,确保您:

  1. 创建了一个 .env 运行服务器的目录中的文件,或者
  2. 已提供 MCP_JIRA_API_URL 和 MCP_JIRA_AUTH_TOKEN 在您的Claude for Desktop配置中 麻省理工学院