项目介绍
Jira MCP Server
这是一个模块化、可扩展的模型上下文协议（MCP）服务器，用于与Jira Cloud进行交互。该项目提供了一组工具来查询看板、问题、用户信息等，使得将Jira与AI代理、机器人或其他自动化系统集成变得容易。
🚀 特性
- 列出所有可用的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处理。 - 您可以在
env部分设置Jira凭据。
注意： 首次运行可能需要几秒钟，因为
npx会下载包。
📦 安装与设置
- 克隆仓库（可选）：
git clone https://github.com/ahmetbarut/jira-mcp.git cd jira-mcp-server - 全局安装（可选）：
npm install -g @ahmetbarut/jira-mcp-server - 设置环境变量：
- 参见上述所需变量。
- 构建项目（如果从源代码使用）：
npm run build - 运行服务器：
jira-mcp-server # 或 npx -y @ahmetbarut/jira-mcp-server
🧩 使用方法
此服务器设计为用作MCP工具服务器，通常通过标准I/O进行交互。您可以使用模型上下文协议检查器与其互动，或将它集成到您自己的MCP兼容代理中。
示例：列出看板
npx @modelcontextprotocol/inspector --cli npx -y @ahmetbarut/jira-mcp-server --method tools/call --tool-name get_boards
示例：获取特定看板上的个人问题
npx @modelcontextprotocol/inspector --cli n
px -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="这是一条测试评论。"
🧰 可用工具
- 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类型和接口
🤝 贡献
欢迎贡献！请遵循以下步骤：
- 分叉仓库
- 创建新分支以添加功能或修复错误：
git checkout -b my-feature - 编写清晰、文档齐全的代码
- 添加或更新测试（如适用）
- 打开拉取请求并详细描述您的更改
- 确保您的代码通过了lint和构建检查
代码风格
- 使用TypeScript，并遵循现有的模块化结构
- 将业务逻辑保留在
handlers.ts中，API辅助函数保留在jiraApi.ts中 - 编写清晰的提交消息
问题
如果您发现了一个bug或有一个功能请求，请在GitHub上尽可能详细地打开一个issue。
📄 许可证
本项目采用MIT许可证。详情请参阅LICENSE。
祝您使用Jira MCP Server愉快！