内容
# Jira MCP Server
<div align="center">
[](https://www.typescriptlang.org/)
[](https://nodejs.org/)
[](https://www.atlassian.com/software/jira)
[](https://www.npmjs.com/)
[](https://opensource.org/licenses/MIT)
[](http://makeapullrequest.com)
</div>
一个用于Jira集成的模型上下文协议(MCP)服务器。该服务器允许像Claude这样的AI助手与Jira进行交互。
<div align="center">
<img src="https://skillicons.dev/icons?i=ts,nodejs,git" alt="Skills" />
</div>
**作者:** Samuel Rizzo
<div align="center">
[](https://github.com/samuelrizzo)
[](https://twitter.com/rizzo_exe)
</div>
## 特性
- 列出所有Jira项目
- 获取详细的任务信息
- 按项目和指派人搜索任务
- 列出项目成员
- 检查用户的项目成员资格和指派的任务
- 创建带有自定义字段的新任务
- 列出和查询带有过滤选项的冲刺
## 安装
```bash
# 克隆仓库
git clone https://github.com/samuelrizzo/jira-mcp-server.git
cd jira-mcp-server
# 安装依赖
npm install
# 构建项目
npm run build
```
## 配置
### MCP服务器配置
将以下配置添加到您的cursor/windsurf mcp设置文件中:
```json
{
"mcpServers": {
"jira-mcp": {
"command": "node",
"args": ["./dist/index.js"],
"env": {
"JIRA_HOST": "your-domain.atlassian.net",
"JIRA_EMAIL": "your-email@example.com",
"JIRA_API_TOKEN": "your-api-token-here"
}
}
}
}
```
### 设置API访问
1. 生成Jira API令牌:
- 前往 [Atlassian账户设置](https://id.atlassian.com/manage-profile/security/api-tokens)
- 点击“创建API令牌”
- 给它命名并点击“创建”
- 复制令牌(您将需要它进行身份验证)
2. 记下您的Jira主机URL(例如,`your-domain.atlassian.net`)和与您的Atlassian账户关联的电子邮件地址。
3. 将这些凭据添加到您的MCP服务器配置中。
## 可用工具
### 1. 列出项目 (`mcp_jira_list_projects`)
列出经过身份验证的用户可以访问的所有Jira项目。
**参数:**
- `jiraHost`: 您的Jira域(例如,'your-domain.atlassian.net')
- `email`: 您的Jira电子邮件
- `apiToken`: 您的Jira API令牌
### 2. 获取任务详情 (`mcp_jira_get_issue`)
检索特定Jira任务的详细信息。
**参数:**
- `issueKey`: Jira任务键(例如,'PROJECT-123')
- `jiraHost`: 您的Jira域
- `email`: 您的Jira电子邮件
- `apiToken`: 您的Jira API令牌
### 3. 搜索任务 (`mcp_jira_search_issues`)
在特定项目中搜索任务,可按指派人进行过滤。
**参数:**
- `projectKey`: Jira项目键
- `assigneeName`: (可选)按指派人名称过滤任务
- `jiraHost`: 您的Jira域
- `email`: 您的Jira电子邮件
- `apiToken`: 您的Jira API令牌
### 4. 列出项目成员 (`mcp_jira_list_project_members`)
列出特定Jira项目的所有成员。
**参数:**
- `projectKey`: Jira项目键
- `jiraHost`: 您的Jira域
- `email`: 您的Jira电子邮件
- `apiToken`: 您的Jira API令牌
### 5. 检查用户任务 (`mcp_jira_check_user_issues`)
检查用户是否是项目成员,并列出他们指派的任务。
**参数:**
- `projectKey`: Jira项目键
- `userName`: 要检查的用户的显示名称
- `jiraHost`: 您的Jira域
- `email`: 您的Jira电子邮件
- `apiToken`: 您的Jira API令牌
### 6. 创建任务 (`mcp_jira_create_issue`)
在Jira项目中创建具有指定详细信息的新任务。
**参数:**
- `projectKey`: Jira项目键
- `summary`: 任务的标题/摘要
- `description`: 任务的详细描述
- `issueType`: (可选)任务类型(例如,'Task','Bug','Story'),默认为'Task'
- `assigneeName`: (可选)指派任务的人的显示名称
- `reporterName`: (可选)报告任务的人的显示名称
- `sprintId`: (可选)要将任务添加到的冲刺ID
- `jiraHost`: 您的Jira域
- `email`: 您的Jira电子邮件
- `apiToken`: 您的Jira API令牌
### 7. 列出冲刺 (`mcp_jira_list_sprints`)
列出Jira中当前的冲刺,并提供过滤选项。
**参数:**
- `boardId`: (可选)按特定看板过滤冲刺的Jira看板ID
- `projectKey`: (可选)项目键,以查找与项目相关的冲刺
- `state`: (可选)按冲刺状态过滤(活动、未来、已关闭或全部),默认为'活动'
- `jiraHost`: 您的Jira域
- `email`: 您的Jira电子邮件
- `apiToken`: 您的Jira API令牌
## 使用示例
以下是您可以使用Claude的一些示例查询:
```
"列出PROJECT中的所有Jira项目"
"获取任务PROJECT-123的详细信息"
"搜索指派给John的PROJECT中的任务"
"列出PROJECT的所有成员"
"检查指派给Jane的PROJECT中的任务"
"在PROJECT中创建一个标题为'登录页面错误'的新bug任务"
"列出PROJECT的活动冲刺"
```
## 持续开发
该项目正在积极开发中。新的工具和功能正在定期添加,以扩展与Jira的集成功能。未来的更新将包括:
- 额外的任务管理工具
- 冲刺和看板管理
- 高级搜索和过滤选项
- 自定义字段处理
- 工作流转换
- 以及更多!
请通过关注或给仓库加星来获取更新。
## 贡献
这是一个开源项目,欢迎贡献!要贡献:
1. Fork该仓库
2. 创建您的功能分支
3. 进行更改
4. 提交拉取请求
## 开源
此代码完全开源。您可以自由地:
- 复制
- 修改
- 分发
- 商业使用
- 私人使用
没有限制 - 随意使用代码!
## 许可证
MIT