内容
# JIRA MCP Server
JIRA MCP Server 的 TypeScript 实现:技术项目经理和工程师的必备 API 集成
## Features
- JQL 搜索功能
- 通过 ID 或 key 检索 Issue
- 与 Model Context Protocol 无缝集成
## Quick Start
使用 npx 安装并运行服务器:
```bash
npx @rujutaranade/likejarvis-jira-mcp-server
npm i likejarvis-jira-mcp-server
```
## Prerequisites
- Node.js (v18 或更高版本)
- 具有 API 访问权限的 JIRA 实例
- JIRA API key/token
## Setup
1. 克隆此 repository
2. 安装依赖项:
```bash
npm install
```
3. 复制环境文件示例并填写您的 JIRA 凭据:
```bash
cp .env.example .env
```
4. 使用您的 JIRA 实例 URL、API key 和用户电子邮件编辑 `.env` 文件
## Building and Running
构建 TypeScript 代码:
```bash
npm run build
```
启动服务器:
```bash
npm start
```
对于具有自动重新加载的开发:
```bash
npm run dev
```
## Available Tools
### 1. JQL Search (`jql_search`)
执行增强的 JQL (JIRA Query Language) 搜索以查找 issue。
Parameters:
- `jql` (required): JQL 查询字符串
- `nextPageToken`: 分页令牌
- `maxResults`: 要返回的最大结果数(默认值:50)
- `fields`: 要包含在响应中的字段列表
- `expand`: 要包含在响应中的其他信息
### 2. Get Issue (`get_issue`)
检索有关特定 issue 的详细信息。
Parameters:
- `issueIdOrKey` (required): issue 的 ID 或 key
- `fields`: 要包含在响应中的字段
- `expand`: 要包含在响应中的其他信息
- `properties`: 要包含在响应中的属性
- `failFast`: 是否在错误时快速失败(默认值:false)
## Environment Variables
- `JIRA_INSTANCE_URL`: 您的 JIRA 实例的 URL
- `JIRA_API_KEY`: 您的 JIRA API key/token
- `JIRA_USER_EMAIL`: 与您的 JIRA 帐户关联的电子邮件
## License
MIT