article
README
🚀 JIRA交互MCP服务器
这是一个提供与JIRA交互工具的Model Context Protocol (MCP)服务器。它允许您通过MCP接口获取活动Sprint中的门票以及详细的问题信息,为JIRA项目管理提供便利。
🚀 快速开始
配置完成后,您可以通过MCP接口在Claude中使用这些工具,实现与JIRA的交互。
✨ 主要特性
该服务器提供了以下工具:
list-sprint-tickets:获取指定项目中活动Sprint的所有门票- 必要参数:
projectKey(字符串)
- 必要参数:
get-ticket-details:获取特定问题的详细信息- 必要参数:
issueKey(字符串)
- 必要参数:
add-comment:在特定问题上添加评论- 必要参数:
issueKey(字符串) - 必要参数:
comment(字符串)
- 必要参数:
link-tickets:使用'相关于'关系链接两个问题- 必要参数:
sourceIssueKey(字符串) - 必要参数:
targetIssueKey(字符串)
- 必要参数:
update-description:更新特定问题的描述- 必要参数:
issueKey(字符串) - 必要参数:
description(字符串)
- 必要参数:
list-child-issues:获取父问题的所有子问题- 必要参数:
parentKey(字符串)
- 必要参数:
create-sub-ticket:为父问题创建子问题(子任务)- 必要参数:
parentKey(字符串) - 必要参数:
summary(字符串) - 可选参数:
description(字符串) - 可选参数:
issueType(字符串)- 子任务问题类型的名称(例如:'子任务')
- 必要参数:
📦 安装指南
- 安装依赖:
npm install - 构建TypeScript代码:
仅在Windows上使用Cline时需要此步骤,因为当前Cline在Windows上执行npx存在问题。
npm run build - 在Claude应用程序设置文件中配置MCP参数(通常位于
~/Library/Application Support/Claude/claude_desktop_config.jsonmacOS或%APPDATA%/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.jsonWindows): Claude的设置:
{
"mcpServers": {
"jira": {
"command": "npx",
"args": ["path/to/this/repo/jira.ts"],
"env": {
"JIRA_HOST": "https://your-domain.atlassian.net",
"JIRA_EMAIL": "your-email@example.com",
"JIRA_API_TOKEN": "your-api-token"
}
}
}
}
Cline的设置:
{
"mcpServers": {
"jira": {
"command": "node",
"args": ["path/to/this/repo/dist/jira.js"],
"env": {
"JIRA_HOST": "https://your-domain.atlassian.net",
"JIRA_EMAIL": "your-email@example.com",
"JIRA_API_TOKEN": "your-api-token"
}
}
}
}
💻 使用示例
基础用法
列出Sprint门票
要获取项目中活动Sprint的所有门票:
<use_mcp_tool>
<server_name>jira</server_name>
<tool_name>list-sprint-tickets</tool_name>
<arguments>
{
"projectKey": "YOUR_PROJECT_KEY"
}
</arguments>
</use_mcp_tool>
获取问题详细信息
要获取特定问题的详细信息:
<use_mcp_tool>
<server_name>jira</server_name>
<tool_name>get-ticket-details</tool_name>
<arguments>
{
"issueKey": "PROJECT-123"
}
</arguments>
</use_mcp_tool>
📚 详细文档
配置
您需要在MCP设置中配置以下环境变量:
JIRA_HOST:您的Atlassian域名URL(例如,https://your-company.atlassian.net)JIRA_EMAIL:您的JIRA账户电子邮件JIRA_API_TOKEN:您的JIRA API令牌- 您可以从Atlassian账户设置生成API令牌
开发
服务器使用TypeScript编写,并且使用:
@modelcontextprotocol/sdk:MCP协议的SDKnode-fetch:用于发送HTTP请求dotenv:加载环境变量
要运行此项目,请按照以下步骤操作:
- 克隆仓库
- 安装依赖:
npm install - 启动服务器:
npm start
错误处理
该工具处理以下错误:
- 无效的项目密钥或问题密钥
- 网络错误
- 无效的评论或其他输入参数
错误消息将以JSON格式返回,其中包含error字段。
Scan to join WeChat group