Jira MCP Server

Jira MCP Server

一个模块化、可扩展的模型上下文协议（MCP）服务，用于与 Jira Cloud 交互。本项目提供了一组用于查询看板、问题、用户信息等的工具，让你可以轻松地将 Jira 集成到 AI Agent、机器人或其他自动化系统中。

🚀 功能

• 列出所有可用的 Jira Scrum 看板
• 列出指定看板中属于自己的问题
• 为 Jira 问题添加评论（符合 ADF 规范）
• 获取当前已认证用户的信息
• 按登录名、电子邮件或显示名称搜索用户
• 获取 Jira 服务信息（包括服务时间）
• 模块化、可扩展，且易于贡献

🛠️ 要求

• Node.js 18+
• 可访问 Jira Cloud 实例
• Jira API Token（参见 Jira API Tokens）

⚙️ 环境变量

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

JIRA_BASE_URL=https://your-domain.atlassian.net
[email protected]
JIRA_API_TOKEN=your-jira-api-token

🚀 快速开始（使用 npx）

无需全局安装，即可通过 npx 立即运行 Jira MCP Server：

npx -y @ahmetbarut/jira-mcp-server

或者，如果你想在配置文件（例如 mcp.json）中将其用作 MCP 工具：

{
  "Jira MCP Server": {
    "command": "npx",
    "args": ["-y", "@ahmetbarut/jira-mcp-server"],
    "env": {
      "JIRA_BASE_URL": "https://your-domain.atlassian.net",
      "JIRA_EMAIL": "[email protected]",
      "JIRA_API_TOKEN": "your-jira-api-token"
    }
  }
}

• 无需运行 npm install 或进行全局安装。
• 所有依赖项均由 npx 处理。
• 你可以在 env 部分设置 Jira 凭据。

注意： 首次运行时，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 的 Agent 中。

示例：列出看板

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 看板
• get_issues：列出指定看板中属于自己的问题
• add_comment_to_issue：为 Jira 问题添加评论（符合 ADF 规范）
• get_current_user_info：获取当前已认证用户的信息
• search_user：按登录名、电子邮件或显示名称搜索用户
• get_server_info：获取 Jira 服务信息（包括服务时间）

🏗️ 项目结构

• src/index.ts — 服务主入口和工具分发器
• src/tools.ts — 工具定义和架构
• src/handlers.ts — 工具处理程序实现（业务逻辑）
• src/jiraApi.ts — Jira API 辅助函数和配置
• src/types.ts — TypeScript 类型和接口

🤝 贡献

欢迎贡献！请按以下步骤操作：

1. Fork 仓库
2. 为你的功能或错误修复创建新分支：

   git checkout -b my-feature
   

3. 编写清晰且文档完善的代码
4. 视情况添加或更新测试
5. 提交 pull request，并清晰说明所做的更改
6. 确保代码通过 lint 和构建检查

代码风格

• 使用 TypeScript，并遵循现有的模块化结构
• 将业务逻辑保留在 handlers.ts 中，将 API 辅助函数保留在 jiraApi.ts 中
• 编写清晰的提交说明

问题

如果你发现错误或有功能请求，请在 GitHub 上提交 issue，并尽可能详细地描述。

📄 许可证

本项目采用 MIT 许可证。详情请参见 LICENSE。

---

祝你使用 Jira MCP Server 自动化愉快！