使用说明
Jira MCP
凭借多年的实际软件开发经验构建的固执己见的Jira MCP服务器。
与一般的Jira集成不同,此MCP是由工程师和自动化质量控制团队的日常工作流程精心制作的。您会发现为实际开发需求而设计的复杂工具,例如检索与问题相关的所有拉取请求、管理复杂的冲刺过渡,或在整个工作流程中跟踪开发信息。
这不仅仅是另一个API包装器。这反映了专业人员如何实际使用Jira:管理冲刺、跟踪开发工作、协调发布以及保持团队之间的可见性。每个工具都是为了解决现代软件开发中出现的实际问题而设计的。
可用工具
问题管理
- jira_get_issue -检索有关特定问题的详细信息,包括状态、受让人、描述、子任务和可用转换
- jira_create_issue -使用指定的详细信息创建新问题(返回密钥、ID和URL)
- jira_create_child_issue -创建与父问题链接的子问题(子任务)
- jira_update_issue -修改现有问题的详细信息(支持部分更新)
- jira_list_issue_types -列出项目中所有可用的问题类型及其ID、名称和描述
搜索
- jira_search_issue -使用JQL(Jira查询语言)和可自定义字段搜索问题并展开选项
Sprint管理
- jira_list_sprints -列出特定董事会或项目的所有活动和未来冲刺
- jira_get_sprint -通过ID检索特定冲刺的详细信息
- jira_get_active_sprint -获取给定董事会或项目的当前活动冲刺
- jira_search_sprint_by_name -按精确或部分匹配的名称搜索冲刺
状态和转换
- jira_list_status -检索项目的所有可用问题状态ID及其名称
- jira_transition问题 -使用有效的转换ID通过其工作流转换问题
评论
- jira_add_注释 -向问题添加注释(使用Atlassian文档格式)
- jira_get_注释 -检索问题的所有评论
工作日志
- jira_add_worklog -添加工作日志条目以跟踪在问题上花费的时间
历史与审计
- jira_get_issue_history -检索问题的完整更改历史记录
问题关系
- jira_get_related_issues -检索有关系的问题(阻止、被阻止、相关等)
- jira_link_问题 -在两个问题之间建立联系,定义它们的关系
版本管理
- jira_get_version -检索特定项目版本的详细信息
- jira_list_项目_版本 -列出项目中的所有版本及其详细信息
发展信息
- jira_get_开发_信息 -通过开发工具集成(GitHub、GitLab、Bitbucket)检索链接到问题的分支、拉取请求和提交
安装
将此提示复制到您的AI助手:
Install the Jira MCP server (https://github.com/nguyenvanduocit/jira-mcp) for my Claude Desktop or Cursor IDE. Read the MCP documentation carefully and guide me through the installation step by step.
如果您的AI助手无法帮助进行此安装,则表示配置错误或AI工具无效。一个有能力的AI助手应该能够指导您完成MCP安装。
CLI使用情况
除了MCP服务器之外, jira-mcp 提供独立的CLI二进制文件(jira-cli)用于直接终端使用——不需要MCP客户端。
安装
just install-cli
# or
go install github.com/nguyenvanduocit/jira-mcp/cmd/jira-cli@latest
快速开始
export ATLASSIAN_HOST=your-instance.atlassian.net
export ATLASSIAN_EMAIL=you@example.com
export ATLASSIAN_TOKEN=your-api-token
# or
jira-cli --env .env <command> [flags]
命令
| 命令 | 描述 |
|---|---|
get-issue |
获取问题详细信息 |
search-issues |
JQL的搜索问题 |
create-issue |
创建新问题 |
update-issue |
更新现有问题 |
add-comment |
向问题添加评论 |
list-comments |
列出对某个问题的评论 |
get-transitions |
获取可用的状态转换 |
transition-issue |
向新状态的过渡问题 |
list-sprints |
列出板上的冲刺 |
get-worklogs |
获取问题的工作日志 |
add-worklog |
记录问题的工作 |
get-history |
获取问题更改历史记录 |
示例
# Get an issue
jira-cli get-issue --issue-key PROJ-123
# Search with JQL
jira-cli search-issues --jql "project = PROJ AND status = 'In Progress'" --max-results 20
# Create an issue
jira-cli create-issue --project PROJ --summary "Fix login bug" --type Bug
# Transition issue
jira-cli get-transitions --issue-key PROJ-123
jira-cli transition-issue --issue-key PROJ-123 --transition-id 31
# JSON output
jira-cli search-issues --jql "assignee = currentUser()" --output json | jq '.[].key'
旗帜
每个命令都接受:
--env string--通往.env文件--output string--输出格式:text(默认)或json
许可证
麻省理工学院——见 LICENSE.
对于AI
本节仅适用于人工智能
使用此代码库时,请阅读以下文件以了解项目结构:
- CLAUDE.md -全面的项目文档,包括架构、开发命令和编码约定
- main.go -显示如何初始化MCP服务器和注册工具的入口点
- 服务/jira_client.go -Singleton Jira客户端初始化和身份验证
- 工具/ -遵循一致模式的单个工具实现
- docs/ -详细文件(见下文结构)
关键概念:
- 这是一个基于Go的MCP服务器,将AI助手连接到Jira
- 每个工具都遵循带有键入输入验证的注册+处理程序模式
- 工具按类别组织(问题、冲刺、评论、工作日志等)
- 所有Jira操作都使用
github.com/ctreminiom/go-atlassian客户端库 - 开发原则记录在
.specify/memory/constitution.md
在做出更改之前,请查看:
- CLAUDE.md 用于架构模式和开发命令
- .define/memory/constitution.md 治理原则
快速开始
1) 获取API令牌
创建一个 https://id.atlassian.com/manage-profile/security/api-tokens.
2) 添加到光标
使用Docker或本地二进制文件(STDIO;不需要端口)。
码头工人
{
"mcpServers": {
"jira": {
"command": "docker",
"args": [
"run", "--rm", "-i",
"-e", "ATLASSIAN_HOST=https://your-company.atlassian.net",
"-e", "ATLASSIAN_EMAIL=your-email@company.com",
"-e", "ATLASSIAN_TOKEN=your-api-token",
"ghcr.io/nguyenvanduocit/jira-mcp:latest"
]
}
}
}
二进制
{
"mcpServers": {
"jira": {
"command": "/usr/local/bin/jira-mcp",
"env": {
"ATLASSIAN_HOST": "https://your-company.atlassian.net",
"ATLASSIAN_EMAIL": "your-email@company.com",
"ATLASSIAN_TOKEN": "your-api-token"
}
}
}
}
3) 在Cursor中尝试
- “显示分配给我的问题”
- “ABC目前的冲刺是什么?”
- “在ABC中创建错误:Safari登录失败”
配置
- atlasian_HOST:
https://your-company.atlassian.net - 澳大利亚电子邮件:您的Atlassian电子邮件
- atlasian_TOKEN:API令牌
可选的 .env (如果在本地运行):
ATLASSIAN_HOST=https://your-company.atlassian.net
ATLASSIAN_EMAIL=your-email@company.com
ATLASSIAN_TOKEN=your-api-token
HTTP模式(可选,用于调试):
jira-mcp -env .env -http_port 3000
游标配置(HTTP模式):
{ "mcpServers": { "jira": { "url": "http://localhost:3000/mcp" } } }
限制暴露的工具(ENABLED_tools)
默认情况下,每个Jira工具都已注册。要仅公开一个子集,例如,向AI代理提供Jira的只读视图,请设置 ENABLED_TOOLS 将环境变量转换为逗号分隔的工具名称列表:
ENABLED_TOOLS=jira_get_issue,jira_search_issue,jira_get_comments
规则:
- 未放置或为空→ 所有工具都是公开的(向后兼容)。
- 名字周围的空格是可以容忍的。
- 未知名称会被忽略,但会在启动时记录,因此拼写错误会立即出现。
- 未列出的名称根本没有注册,因此MCP客户端永远看不到它们。
只读代理示例(暴露15个读取,阻止所有8个变异工具):
ENABLED_TOOLS=jira_get_issue,jira_search_issue,jira_list_statuses,jira_get_comments,jira_get_issue_history,jira_get_related_issues,jira_list_sprints,jira_get_sprint,jira_get_active_sprint,jira_search_sprint_by_name,jira_get_version,jira_list_project_versions,jira_get_development_information,jira_download_attachment,jira_list_issue_types
安装
自制(macOS/Linux)
brew install nguyenvanduocit/tap/jira-mcp