article
README
🚀 JIRA MCP 服务器
JIRA MCP 服务器是一个 MCP 服务器,它让大型语言模型(LLMs)能借助标准化工具和上下文与 JIRA 进行交互。此服务器具备使用 JQL 搜索问题以及检索特定问题详细信息的功能,为用户在 JIRA 系统中高效获取信息提供了便利。
🚀 快速开始
若要使用 JIRA MCP 服务器,需完成以下先决条件的准备:
- 安装了
npm - 带有 API 访问权限的 JIRA 实例
- JIRA API 令牌或个人访问令牌
- 与 API 令牌关联的 JIRA 用户电子邮件地址
获取 JIRA API 凭证
- 登录到您的 Atlassian 账户:https://id.atlassian.com
- 转到安全设置。
- 在 API 令牌下,选择“创建 API 令牌”。
- 给令牌提供一个有意义的名字(例如,“MCP 服务器”)。
- 复制生成的令牌——您将无法再次看到它!
- 使用此令牌作为您的
JIRA_API_KEY。 - 使用与 Atlassian 账户关联的电子邮件地址作为
JIRA_USER_EMAIL。
✨ 主要特性
- JQL 搜索:可执行复杂的 JQL 查询,并且支持分页功能,方便用户按需求获取问题列表。
- 问题详细信息:能够检索特定 JIRA 问题的详细信息,包括问题的描述、标签、评论、历史记录等。
📦 安装指南
使用 npm 安装
npm install jira-mcp-server
手动安装
- 下载最新版本的压缩包。
- 解压文件到目标目录。
- 运行服务器:
node index.js
💻 使用示例
与 Claude Desktop 集成
- 将服务器配置添加到 Claude Desktop 的配置文件中:
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - Windows:
%APPDATA%\Claude\claude_desktop_config.json
- macOS:
{
"mcpServers": {
"jira": {
"command": "npx",
"args": ["-y", "jira-mcp"],
"env": {
"JIRA_INSTANCE_URL": "https://your-instance.atlassian.net",
"JIRA_USER_EMAIL": "your-email@company.com",
"JIRA_API_KEY": "your-api-token"
}
}
}
}
- 重新启动 Claude Desktop 以加载新的配置。
可用工具
1. JQL 搜索 (jql_search)
执行带有自定义参数的 JQL 查询。 输入示例:
{
"command": "jql_search",
"issueQuery": "project = ABC AND status = 'In Progress'",
"maxResults": 50,
"startIndex": 0
}
输出示例:
{
"issues": [
{
"id": "1234",
"key": "ABC-123",
"title": "Implement New Feature",
"status": "In Progress",
"priority": "High",
"assignee": "张三"
},
// 其他问题...
],
"total": 100
}
2. 检索问题详细信息 (get_issue)
检索特定问题的详细信息。 输入示例:
{
"command": "get_issue",
"issueIdOrKey": "ABC-123"
}
输出示例:
{
"id": "1234",
"key": "ABC-123",
"title": "Implement New Feature",
"status": "In Progress",
"priority": "High",
"assignee": "张三",
"description": "需要实现新功能...",
"labels": ["feature", "urgent"],
"comments": [
{
"id": "5678",
"author": "李四",
"content": "请优先处理此问题。",
"createdAt": "2023-10-01T12:00:00Z"
},
// 其他评论...
],
"history": [
{
"actionDate": "2023-10-01T10:00:00Z",
"action": "status changed to 'In Progress'"
},
// 其他记录...
]
}
📚 详细文档
配置
环境变量
创建一个 .env 文件并添加以下内容:
JIRA_INSTANCE_URL=https://your-instance.atlassian.net
JIRA_USER_EMAIL=your-email@company.com
JIRA_API_KEY=your-api-token
📄 许可证
本项目采用 MIT 许可证。
🤝 贡献指南
欢迎大家为项目贡献代码!请随时提交 PR。
微信扫一扫