用途
jira-mcp 是一个开源模型上下文协议(MCP)服务器,面向 Jira 与 Atlassian。它把 Jira 的项目管理能力接入任何兼容 MCP 的 AI 客户端,使用户无需离开 AI 助手即可操作 Jira 中的问题、冲刺、评论、用户和 Confluence 页面。
兼容的 AI 客户端
项目资料仅说明“兼容任何 MCP 客户端”,并列举 Claude、Cursor 作为示例,同时提到可在 MCP Market、MCP Servers、Claude Marketplaces、npm 等目录中找到该服务器。未提供具体受支持客户端清单。
主要能力
- 项目管理:列出项目和问题类型。
- 问题 CRUD:创建、读取、更新、删除问题。
- 评论:创建、读取、更新、删除评论,支持分页增强。
- 状态流转:在状态之间移动问题。
- 分配:将问题分配给用户。
- 用户管理:搜索和管理用户。
- 冲刺管理:完整的敏捷冲刺生命周期管理。
- Wiki 集成:通过 URL 标识符访问 Confluence 页面,并将 HTML 转换为文本。
- 富文本支持:将 Markdown 转换为 ADF,用于格式化的问题描述和评论。
- 校验:使用 Yup schema 校验。
- 认证:完整支持 Jira Cloud。
- 响应优化:为节省 token 做字段过滤。
- 类型安全:完整的 TypeScript 支持。
使用方式
有两种方式:
- 使用 npx(推荐):在 MCP 客户端(例如 Claude Desktop)中配置该服务器,并配置 Jira API token。服务器会在需要时自动下载并运行,无需额外安装。npm 包名为
npx raalarcon-jira-mcp-server。 - 本地开发:克隆仓库、安装依赖、构建项目,然后在 MCP 客户端中配置指向构建后服务器的完整路径。
获取 API token:前往 Atlassian Account Settings,点击 "Create API token",填写名称并复制生成的 token。
富文本(Markdown 到 ADF)
服务器支持自动将 Markdown 转换为 Atlassian Document Format(ADF),用于问题描述和评论。支持的语法包括:标题(# H1、## H2、### H3)、文本格式(bold、italic)、代码(inline code 与代码块)、列表(- 项目符号列表、1. 编号列表)、链接(text)、引用(> quoted text)、复选框(- [x] completed task)。
可用工具
- 获取项目:返回已认证用户可访问的所有项目。可选参数 expand、recent(0-20)。
- 获取问题类型:按 projectKey 获取某项目可用问题类型。
- 创建问题:参数包括 summary(必填)、issueType(必填)、description、priority、assignee、labels、components、fixVersions、customFields。
- 获取问题:按 issueKey 获取详情(为节省 token 过滤自定义字段),可选 expand、fields。
- 更新问题:按 issueKey 更新 summary、description、priority、assignee、labels、components、fixVersions、customFields。
- 删除问题:按 issueKey 删除,可选 deleteSubtasks(默认 false)。
- 添加评论:按 issueKey、body(支持 ADF)添加,可选 visibility。
- 获取评论:按 issueKey 获取,可选 startAt(默认 0)、maxResults(1-100,默认 50)。
- 更新评论:按 commentId、body 更新,可选 visibility。
- 删除评论:按 commentId 删除。
- 获取状态流转:按 issueKey 获取可用流转。
- 执行流转:按 issueKey、transitionId 流转,可选 comment、fields。
- 分配问题:按 issueKey、assignee(用户 account ID)分配。
- 搜索用户:可选 query、projectKey、maxResults(1-100,默认 50)。
- 获取当前用户:返回当前已认证用户信息。
冲刺管理
- 获取敏捷看板:可选 projectKey、boardType(scrum、kanban),用于找到冲刺操作所需的看板 ID。
- 获取冲刺:按 boardId 获取,可选 state(active、closed、future)。
- 创建冲刺:name、originBoardId 必填,startDate、endDate、goal 可选。
- 更新冲刺:按 sprintId 更新 name、startDate、endDate、goal、state;已关闭冲刺仅可更新 name 和 goal。
- 关闭冲刺:按 sprintId 关闭,要求冲刺处于 active 状态,关闭后无法重新打开。
- 删除冲刺:按 sprintId 删除,冲刺中未完成问题会移入 backlog,不可逆。
- 移动问题到冲刺:按 issueKey、sprintId 移动,只能移动到 open 或 active 冲刺。
- 获取冲刺问题:按 sprintId 获取问题列表,可选 maxResults(1-100,默认 50)。
Confluence 集成
通过 URL 标识符访问 Confluence 页面并返回格式化内容:query(必填)为页面代码(例如 F4CjNw)。特性包括:自动跟随短 URL 重定向、HTML 转纯文本并保留结构、显示页面层级、全面的错误处理。
响应优化
服务器针对 token 效率做了优化:仅返回必要字段;自动过滤问题响应中的自定义字段;使用简短字段名(例如 desc 代替 description);清晰简洁的成功确认信息;跨所有工具保持一致的结构化响应格式。
错误处理
包含带描述信息的健壮错误处理,常见错误包括:认证(凭据无效或过期)、权限(操作权限不足)、校验(输入数据无效)、资源(问题或项目未找到)、API(速率限制或 Jira 服务器错误)。
项目结构与开发
项目结构按仓库说明组织。新增功能步骤:在 src/schemas/index.ts 创建校验 schema;在 src/jira-client.ts 实现方法;在 src/tools/ 下相应文件创建 MCP 工具;在 src/index.ts 注册工具。
测试可使用 MCP Inspector:npm install -g @modelcontextprotocol/inspector;构建项目 npm run build;启动 npx @modelcontextprotocol/inspector;在界面中配置:Transport 为 STDIO(默认),Command 为 node,Args 为 build/index.js,并在 Environment 添加 Jira 凭据。也支持 CLI 模式用于自动化与脚本,以及配置文件方式用于复杂设置。
贡献指南
欢迎贡献。步骤:在 GitHub fork 仓库;本地克隆 git clone https://github.com/raalarcon9705/jira-mcp.git 后 cd jira-mcp;npm install;创建分支 git checkout -b feature/your-feature-name。开发要求:全部代码使用 TypeScript;避免 any,使用正确的 Jira.js 类型;包含全面错误处理;使用 Yup schema 做输入校验;为复杂逻辑添加清晰注释;遵循现有代码风格与格式。
Pull Request 前需确认:代码无 TypeScript 错误、所有工具按预期工作、已实现响应优化、错误处理全面、文档按需更新、示例中不包含个人数据。提交信息清晰,推送分支后打开 Pull Request。
限制
项目资料未提供关于收费、价格、平台支持范围、性能效果、使用步骤之外的额外信息;上述未提及内容暂未提供。