README
🚀 JIRA MCP 服务器
这是一个用 TypeScript 实现的 JIRA MCP 服务器,为技术项目经理和技术工程师提供基础 API 集成,助力高效处理 JIRA 相关事务。
🚀 快速开始
使用 npx 安装并运行服务器:
npx @rujutaranade/likejarvis-jira-mcp-server
npm i likejarvis-jira-mcp-server
✨ 主要特性
- JQL 搜索功能:可执行增强的 JQL 搜索,精准查找问题。
- 通过 ID 或键获取问题:能快速获取特定问题的详细信息。
- 与模型上下文协议无缝集成:实现更流畅的数据交互。
📦 安装指南
先决条件
- Node.js(v18 或更高版本)
- 带有 API 访问权限的 JIRA 实例
- JIRA API 密钥/令牌
设置步骤
- 克隆此仓库。
- 安装依赖项:
npm install - 复制环境文件示例并填写您的 JIRA 凭证:
cp .env.example .env - 使用您的 JIRA 实例 URL、API 密钥和用户电子邮件编辑
.env文件。
构建和运行
- 构建 TypeScript 代码:
npm run build
- 启动服务器:
npm start
- 用于开发的自动重载:
npm run dev
💻 使用示例
可用工具
1. JQL 搜索 (jql_search)
执行增强的 JQL(JIRA 查询语言)搜索以查找问题。
参数:
jql(必需):JQL 查询字符串nextPageToken:分页令牌maxResults:要返回的最大结果数(默认值:50)fields:包含在响应中的字段列表expand:响应中包含的其他信息
2. 获取问题 (get_issue)
获取特定问题的详细信息。
参数:
issueIdOrKey(必需):问题的 ID 或密钥fields:要包含在响应中的字段expand:响应中包含的其他信息properties:要包含在响应中的属性failFast:是否在错误时快速失败(默认值:false)
📚 详细文档
环境变量
| 属性 | 详情 |
|------|------|
| JIRA_INSTANCE_URL | 您的 JIRA 实例 URL |
| JIRA_API_KEY | 您的 JIRA API 密钥/令牌 |
| JIRA_USER_EMAIL | 与您的 JIRA 帐户关联的电子邮件 |
📄 许可证
本项目采用 MIT 许可证。
Scan to join WeChat group