内容
# JIRA MCP 服务器
[](https://smithery.ai/server/jira-mcp)
一个 MCP 服务器,使大型语言模型(LLMs)能够通过标准化的工具和上下文与 JIRA 进行交互。该服务器提供使用 JQL 搜索问题和检索详细问题信息的功能。
<a href="https://glama.ai/mcp/servers/4e3sqj7af1"><img width="380" height="200" src="https://glama.ai/mcp/servers/4e3sqj7af1/badge" alt="jira-mcp MCP 服务器" /></a>
## 功能特点
- **JQL 搜索**: 执行复杂的 JQL 查询,支持分页
- **问题详情**: 检索特定 JIRA 问题的详细信息
## 前置条件
- 已安装 `npm`
- 具有 API 访问权限的 JIRA 实例
- JIRA API 令牌或个人访问令牌
- 与 API 令牌关联的 JIRA 用户邮箱
### 获取 JIRA API 凭证
1. 登录到您的 Atlassian 账户,网址为 https://id.atlassian.com
2. 导航到安全设置
3. 在 API 令牌下,选择“创建 API 令牌”
4. 为您的令牌取一个有意义的名称(例如,“MCP 服务器”)
5. 复制生成的令牌 - 您将无法再次看到它!
6. 将此令牌用作您的 `JIRA_API_KEY`
7. 使用与您的 Atlassian 账户关联的电子邮件地址作为 `JIRA_USER_EMAIL`
## 使用方法
### 与 Claude Desktop 集成
1. 将服务器配置添加到 Claude Desktop 的配置文件中:
**macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
**Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
```json
{
"mcpServers": {
"jira": {
"command": "npx",
"args": ["-y", "jira-mcp"],
"env": {
"JIRA_INSTANCE_URL": "https://your-instance.atlassian.net",
"JIRA_USER_EMAIL": "your-email@company.com",
"JIRA_API_KEY": "your-api-token"
}
}
}
}
```
2. 重启 Claude Desktop 以加载新配置。
## 可用工具
### 1. JQL 搜索 (`jql_search`)
执行具有可自定义参数的 JQL 搜索查询。
**参数**:
- `jql`(必填):JQL 查询字符串
- `nextPageToken`:分页令牌
- `maxResults`:要返回的最大结果数
- `fields`:要包含的字段名称数组
- `expand`:要包含的附加信息
**示例**:
```json
{
"jql": "project = 'MyProject' AND status = 'In Progress'",
"maxResults": 10,
"fields": ["summary", "status", "assignee"]
}
```
### 2. 获取问题 (`get_issue`)
检索特定问题的详细信息。
**参数**:
- `issueIdOrKey`(必填):问题 ID 或键
- `fields`:要包含的字段名称数组
- `expand`:要包含的附加信息
- `properties`:要包含的属性数组
- `failFast`:是否快速失败并报错
**示例**:
```json
{
"issueIdOrKey": "PROJ-123",
"fields": ["summary", "description", "status"],
"expand": "renderedFields,names"
}
```
## 开发
### 配置
在运行服务器之前设置环境变量。在根目录中创建 `.env` 文件:
```env
JIRA_INSTANCE_URL=https://your-instance.atlassian.net
JIRA_USER_EMAIL=your-email@company.com
JIRA_API_KEY=your-api-token
```
替换值为:
- 您实际的 JIRA 实例 URL
- 与您的 JIRA 账户关联的电子邮件地址
- 您的 JIRA API 令牌(可在 Atlassian 账户设置中生成)
### 安装
### 通过 Smithery 安装
通过 [Smithery](https://smithery.ai/server/jira-mcp) 自动安装 JIRA for Claude Desktop:
```bash
npx -y @smithery/cli install jira-mcp --client claude
```
### 手动安装
1. 克隆此仓库:
```bash
git clone <repository-url>
cd jira-mcp
```
2. 安装依赖项:
```bash
npm install
```
### 使用 MCP Inspector 运行
对于测试和开发,您可以使用 MCP Inspector:
```bash
npm run inspect
```
### 添加新工具
要添加新工具,请修改 `index.js` 中的 `ListToolsRequestSchema` 处理程序:
```javascript
server.setRequestHandler(ListToolsRequestSchema, async () => {
return {
tools: [
// 现有工具...
{
name: "your_new_tool",
description: "您的新工具描述",
inputSchema: {
// 定义输入模式...
}
}
]
};
});
```
然后在 `CallToolRequestSchema` 处理程序中实现该工具。
## 许可证
MIT
## 贡献
欢迎贡献!请随时提交 PR。