使用说明
MCP Jira服务器
一个模型上下文协议(MCP)服务器,将Jira与Claude Desktop集成在一起,允许您直接通过Claude获取和查看Jira问题详细信息。
特性
- 🔍 获取Jira问题详细信息:按密钥获取有关任何Jira问题的全面信息
- 📁 浏览项目:列出项目并查看项目详细信息
- 🧭 了解工作流程:查看每个项目的问题类型和状态
- 🔎 搜索问题(JQL):具有分页和选定字段的灵活搜索
- 📌 项目问题列表:快速列出项目中的问题
- 💬 问题评论:阅读对某个问题的评论
- 🗂️ 敏捷视图:董事会、冲刺和冲刺问题列表
- 🔐 安全认证:使用Jira API令牌进行安全访问
- 🎯 结构化数据:返回人类可读和结构化的JSON数据
- 🚀 Claude桌面集成:通过MCP协议与Claude Desktop无缝协作
先决条件
- Node.js(v18或更高版本)
- Claude桌面应用程序
- 具有API访问权限的Jira实例
- Jira API代币
安装
-
克隆仓库
git clone https://github.com/imrnbeg/jira-mcp.git cd jira-mcp -
安装依赖项
npm install -
构建项目
npm run build
配置
1.创建环境文件
创建一个 .env 使用Jira凭据在项目根目录中创建文件:
# .env
JIRA_URL=https://yourcompany.atlassian.net
JIRA_EMAIL=your.email@company.com
JIRA_API_TOKEN=your_api_token_here
如何获取Jira API代币:
- 首选 Atlassian帐户设置
- 点击“创建API令牌”
- 给它一个标签(例如“MCP服务器”)
- 复制生成的令牌
2.更新服务器路径(重要!)
⚠️ 关键: 您必须更新 .env 服务器代码中的文件路径,以匹配您的系统。
编辑 src/server.ts 并更新第8行:
// Change this path to match your system
loadEnvFile('/Users/imranbeg/mcp-get-server/.env');
对于不同的系统:
- macOS/Linux:
/full/path/to/your/jira-mcp/.env - 视窗:
C:\\full\\path\\to\\your\\jira-mcp\\.env
3.路径更新后重建
更新路径后,重建项目:
npm run build
Claude桌面设置
1.找到Claude桌面配置
macOS:
~/Library/Application Support/Claude/claude_desktop_config.json
窗户:
%APPDATA%\Claude\claude_desktop_config.json
2.添加MCP服务器配置
将此配置添加到您的Claude Desktop配置文件中:
{
"mcpServers": {
"mcp-jira-server": {
"command": "node",
"args": ["/full/path/to/your/jira-mcp/dist/server.js"],
"cwd": "/full/path/to/your/jira-mcp"
}
}
}
⚠️ 更新路径 要匹配您的系统:
- 替换
/full/path/to/your/jira-mcp使用您的实际项目路径 - 使用正斜杠(
/)即使在Windows上
3.重新启动克劳德桌面
更新配置后,完全退出并重新启动Claude Desktop。
用法
配置后,您可以在Claude Desktop中使用这些示例提示:
基本问题查找
Get details for Jira issue PROJ-123
Show me information about ticket TASK-456
What's the status of issue BUG-789?
详细问题信息
Get comprehensive details for Jira issue PROJ-123 including description, assignee, and priority
Show me the full details for ticket TASK-456 with all available information
多个问题
Get details for these Jira issues: PROJ-123, TASK-456, BUG-789
问题状态检查
What's the current status and assignee for issue PROJ-123?
Check the priority and due date for ticket TASK-456
可用工具
get_jira_issue
获取Jira问题的详细信息。
参数:
issueKey(string):Jira问题密钥(例如PROJ-123、TASK-456)
退货:
- 问题摘要、描述、状态、受让人、报告人
- 优先级、问题类型、创建和更新日期
- 直接链接到Jira中的问题
- 用于程序化访问的结构化JSON数据
list_jira_projects
使用分页和可选搜索查询列出可访问的Jira项目。
参数:
query(字符串,可选):按关键字/名称搜索startAt(数字,可选):分页开始maxResults(数字,可选):页面大小(1-100)
get_jira_project
按键或ID获取Jira项目的完整元数据。
参数:
projectIdOrKey(string):项目密钥或ID
get_project_statuses
获取项目中每种问题类型的可用状态。
参数:
projectIdOrKey(string):项目密钥或ID
search_jira_issues
使用JQL进行分页和字段选择搜索问题。
参数:
jql(字符串):JQL查询startAt(数字,可选):分页开始maxResults(数字,可选):页面大小(1-100)fields(字符串,可选):逗号分隔的字段
list_project_issues
使用可选的额外JQL列出特定项目中的问题。
参数:
projectKey(string):项目密钥jqlTail(字符串,可选):额外的JQL(例如,AND状态=“进行中”)startAt(数字,可选):分页开始maxResults(数字,可选):页面大小(1-100)
get_jira_issue_comments
检索Jira问题的评论。
参数:
issueIdOrKey(string):发布密钥或IDstartAt(数字,可选):分页开始maxResults(数字,可选):页面大小(1-100)
list_boards
列出带有可选过滤器的Jira板。
参数:
type(“scrum”|“kanban”,可选):板类型projectKeyOrId(字符串,可选):按项目筛选startAt(数字,可选):分页开始maxResults(数字,可选):页面大小(1-100)
list_board_sprints
在黑板上列出冲刺。
参数:
boardId(编号):板IDstate(“活动”|“未来”|“关闭”,可选):Sprint状态startAt(数字,可选):分页开始maxResults(数字,可选):页面大小(1-100)
list_sprint_issues
在sprint中用分页列出问题。
参数:
sprintId(数字):Sprint IDstartAt(数字,可选):分页开始maxResults(数字,可选):页面大小(1-100)jql(字符串,可选):附加JQL筛选器
示例提示
使用Claude Desktop中的这些提示来利用工具:
项目发现
List my Jira projects.
Search Jira projects matching "platform".
Show details for project PROJ.
What issue types and statuses exist in project PROJ?
问题搜索和浏览
Find issues in project PROJ assigned to me that are In Progress.
Search issues updated in the last 7 days with label "release".
List issues in project PROJ with status = "To Do".
Get comments for issue PROJ-123.
敏捷视图
List all Scrum boards for project PROJ.
Show active sprints on board 12.
List issues in sprint 345 ordered by priority.
发展
以开发模式运行
npm run dev
生产大楼
npm run build
类型检查
npm run typecheck
故障排除
服务器未加载环境变量
- 检查路径
src/server.ts-确保它指向你的实际.env文件位置 - 重建项目 更改路径后:
npm run build - 验证
.env文件存在 并且包含有效凭据
克劳德桌面未连接
- 检查配置文件路径 -确保所有路径
claude_desktop_config.json是正确的 - 重新启动克劳德桌面 完全
- 检查克劳德桌面日志 连接错误
Jira API错误
- 验证您的API令牌 有效且未过期
- 检查您的Jira URL 格式(应包括
https://) - 确保您的帐户 有权访问Jira实例
项目结构
jira-mcp/
├── src/
│ ├── server.ts # Main MCP server implementation
│ └── load-env.ts # Custom environment loader
├── dist/ # Compiled JavaScript files
├── .env # Environment variables (create this)
├── package.json # Dependencies and scripts
├── tsconfig.json # TypeScript configuration
└── README.md # This file
贡献
- 复刻仓库
- 创建要素分支
- 进行更改
- 彻底测试
- 提交拉取请求
许可证
ISC许可证
支持
对于问题和疑问:
- 检查上面的故障排除部分
- 查看 MCP文件
- 在GitHub上打开一个问题
Jira与Claude的整合愉快! 🚀