Jira MCP服务器

一个模块化、可扩展的模型上下文协议(MCP)服务器,用于与Jira Cloud交互,提供查询看板、问题、用户信息等功能,便于将Jira与AI代理、机器人或其他自动化系统集成。

  • by ahmetbarut
  • TypeScript
  • 本地部署
  • 2 星标
  • 更新于
在 GitHub 查看 ahmetbarut/jira-mcp

使用说明

Jira MCP服务器

用于与Jira Cloud交互的模块化、可扩展的模型上下文协议(MCP)服务器。该项目提供了一套工具来查询公告板、问题、用户信息等,使Jira与人工智能代理、机器人或其他自动化系统的集成变得容易。

🚀 特性

  • 列出所有可用的Jira scrum板
  • 为特定董事会列出自己的问题
  • 为Jira问题添加评论(符合ADF)
  • 获取当前经过身份验证的用户信息
  • 按登录名、电子邮件或显示名称搜索用户
  • 获取Jira服务器信息(包括服务器时间)
  • 模块化、可扩展且易于贡献

🛠️ 需求

  • Node.js 18+
  • 访问Jira Cloud实例
  • Jira API代币(参见 Jira API代币)

⚙️ 环境变量

在shell中设置以下环境变量或 .env 文件:

JIRA_BASE_URL=https://your-domain.atlassian.net
JIRA_EMAIL=your-email@company.com
JIRA_API_TOKEN=your-jira-api-token

🚀 快速入门(使用npx)

您可以使用npx立即运行Jira MCP服务器,无需全局安装:

npx -y @ahmetbarut/jira-mcp-server

或者,如果你想在配置文件中将其用作MCP工具(例如。 mcp.json):

{
  "Jira MCP Server": {
    "command": "npx",
    "args": ["-y", "@ahmetbarut/jira-mcp-server"],
    "env": {
      "JIRA_BASE_URL": "https://your-domain.atlassian.net",
      "JIRA_EMAIL": "your-email@company.com",
      "JIRA_API_TOKEN": "your-jira-api-token"
    }
  }
}
  • 不需要 npm install 或全局安装。
  • 所有依赖关系均由处理 npx.
  • 您可以在中设置Jira凭据 env 部分。

注: 第一次运行可能需要几秒钟,因为 npx 下载包。

📦 安装和设置

  1. 克隆存储库(可选):
    git clone https://github.com/ahmetbarut/jira-mcp.git
    cd jira-mcp-server
    
  2. 全局安装(可选):
    npm install -g @ahmetbarut/jira-mcp-server
    
  3. 设置环境变量:
    • 所需变量见上文。
  4. 构建项目(如果从源代码使用):
    npm run build
    
  5. 运行服务器:
    jira-mcp-server
    # or
    npx -y @ahmetbarut/jira-mcp-server
    

🧩 用法

此服务器被设计为用作MCP工具服务器,通常通过stdio。您可以使用 模型上下文协议检查器 或者将其集成到您自己的MCP兼容代理中。

示例:列表板

npx @modelcontextprotocol/inspector --cli npx -y @ahmetbarut/jira-mcp-server --method tools/call --tool-name get_boards

示例:将您的问题提交给董事会

npx @modelcontextprotocol/inspector --cli npx -y @ahmetbarut/jira-mcp-server --method tools/call --tool-name get_issues --tool-arg boardId=123

示例:向问题添加评论

npx @modelcontextprotocol/inspector --cli npx -y @ahmetbarut/jira-mcp-server --method tools/call --tool-name add_comment_to_issue --tool-arg issueIdOrKey=PROJ-123 --tool-arg body="This is a test comment."

🧰 可用工具

  • get_boards:列出所有可用的Jira scrum板
  • 获取问题:为特定董事会列出您的问题
  • add_comment_to_oissue:为Jira问题添加评论(符合ADF)
  • get_current_user_info:获取当前经过身份验证的用户信息
  • 搜索用户:通过登录名、电子邮件或显示名称搜索用户
  • get_server_info:获取Jira服务器信息(包括服务器时间)

🏗️ 项目结构

  • src/index.ts --主服务器入口点和工具调度器
  • src/tools.ts --工具定义和模式
  • src/handlers.ts --工具处理程序实现(业务逻辑)
  • src/jiraApi.ts -Jira API助手和配置
  • src/types.ts --TypeScript类型和接口

🤝 贡献

欢迎投稿!请按照以下步骤操作:

  1. 分叉存储库
  2. 创建新分支 对于您的功能或错误修复:
    git checkout -b my-feature
    
  3. 编写清晰、文档齐全的代码
  4. 添加或更新测试 如适用
  5. 打开拉取请求 清楚地描述您的更改
  6. 确保你的代码通过lint和build检查

代码的风格

  • 使用TypeScript并遵循现有的模块化结构
  • 保持业务逻辑 handlers.ts 和中的API助手 jiraApi.ts
  • 写明确的提交消息

问题

如果你发现一个bug或有一个功能请求,请在GitHub上打开一个问题,尽可能详细。

📄 许可证

该项目根据MIT许可证获得许可。看 许可证 了解详情。


使用Jira MCP服务器实现自动化!