article
README
🚀 Jira MCP 服务器
Jira MCP 服务器是一个与 Jira REST API 集成的 Model Context Protocol (MCP) 服务器,它使 AI 助手能够以编程方式管理 Jira 问题,为 Jira 问题管理提供了高效便捷的解决方案。
✨ 主要特性
该服务器提供了一系列管理 Jira 问题的实用工具:
- 创建问题:可创建新的任务、史诗、子任务等不同类型的问题。
- 列出问题:支持列出问题,并可根据状态进行过滤。
- 更新问题:能够更新现有问题的标题、描述和状态等信息。
- 获取详情:可以获取问题的详细信息。
- 删除问题:允许删除指定的 Jira 问题。
- 添加评论:支持向问题添加评论。
📦 安装指南
先决条件
- 拥有具备 API 访问权限的 Jira 账户。
- 准备好 Jira API 令牌,可在 Atlassian 账户设置 生成。
安装步骤
- 安装项目依赖:
npm install
- 构建服务器:
npm run build
配置步骤
- 在工作目录中创建
.jira-config.json文件:
{
"projectKey": "YOUR_PROJECT_KEY"
}
- 配置 MCP 服务器的 Jira 凭据:
- 在 MacOS 上:
~/Library/Application Support/Claude/claude_desktop_config.json - 在 Windows 上:
%APPDATA%/Claude/claude_desktop_config.json
{
"mcpServers": {
"jira": {
"command": "node",
"args": ["/path/to/jira-server/build/index.js"],
"env": {
"JIRA_EMAIL": "your-email@example.com",
"JIRA_API_TOKEN": "your-api-token",
"JIRA_DOMAIN": "your-domain"
}
}
}
}
💻 使用示例
create_issue
创建新的 Jira 问题。
- 必要参数:
working_dir:包含.jira-config.json的目录。summary:问题标题。description:问题描述。type:问题类型(任务、史诗或子任务)。
list_issues
列出项目中的问题。
- 必要参数:
working_dir:包含.jira-config.json的目录。
- 可选参数:
status:按状态过滤(例如,“待办事项”、“进行中”、“完成”)。
update_issue
更新现有问题。
- 必要参数:
working_dir:包含.jira-config.json的目录。issue_key:问题密钥(例如,PRJ - 123)。
- 可选参数:
summary:新标题。description:新描述。status:新状态。
get_issue
获取特定问题的详细信息。
- 必要参数:
working_dir:包含.jira-config.json的目录。issue_key:问题密钥(例如,PRJ - 123)。
delete_issue
删除 Jira 问题。
- 必要参数:
working_dir:包含.jira-config.json的目录。issue_key:问题密钥(例如,PRJ - 123)。
add_comment
向现有问题添加评论。
- 必要参数:
working_dir:包含.jira-config.json的目录。issue_key:问题密钥(例如,PRJ - 123)。comment:要添加的评论文本。
📚 详细文档
开发
使用自动重建进行开发:
npm run watch
错误处理
该服务器具备全面的错误处理功能,可处理以下常见错误:
- 无效项目密钥
- 配置文件缺失
- 无效问题类型
- API 身份验证错误
- 无效状态转换
输出格式
问题信息将以以下格式显示:
- 问题密钥和标题
- 问题类型和状态
- 创建日期和创建者
- 描述
- 评论(如有)及其作者和时间戳
微信扫一扫