使用说明
Jira MCP服务器
只读 模型上下文协议 (MCP)服务器,为AI代理提供对Jira Cloud的结构化访问。
特征
- 通过REST API v3对Jira Cloud进行只读访问
- 项目列表和健康摘要
- 史诗般的浏览与进度跟踪
- 问题检索和JQL搜索
- Sprint概述及状态分组
- 具有可配置TTL的API响应缓存
- 用于细粒度访问控制的工具分配列表/块列表
- 限制查询范围的项目密钥限制
快速开始
先决条件
- Node.js>=20
- 带有API令牌的Jira Cloud实例(在此处生成一个)
安装并运行
# Install dependencies
npm install
# Copy and fill in environment variables
cp .env.example .env
# Edit .env with your Jira credentials
# Run in development mode
npm run dev
# Or build and run production
npm run build
npm start
Claude桌面设置
添加到您的 claude_desktop_config.json:
{
"mcpServers": {
"jira": {
"command": "node",
"args": ["/absolute/path/to/jira-mcp-server/dist/server.js"],
"env": {
"JIRA_INSTANCE_URL": "https://your-domain.atlassian.net",
"JIRA_API_TOKEN": "your-api-token",
"JIRA_USER_EMAIL": "you@example.com"
}
}
}
}
Claude代码设置
添加到您的项目 .mcp.json:
{
"mcpServers": {
"jira": {
"command": "node",
"args": ["/absolute/path/to/jira-mcp-server/dist/server.js"],
"env": {
"JIRA_INSTANCE_URL": "https://your-domain.atlassian.net",
"JIRA_API_TOKEN": "your-api-token",
"JIRA_USER_EMAIL": "you@example.com"
}
}
}
}
或者通过CLI:
claude mcp add jira -- node /absolute/path/to/jira-mcp-server/dist/server.js
可用工具
| 工具 | 说明 |
|---|---|
list_projects |
列出服务器可访问的所有Jira项目。 |
get_project_summary |
获取高级项目运行状况摘要。 |
list_epics |
列出项目中的所有史诗及其进度信息。 |
get_epic_children |
获取特定史诗的儿童问题。 |
get_issue_subtasks |
获取给定问题的所有子任务。 |
get_issue |
获取特定Jira问题的完整详细信息。 |
search_issues |
使用JQL搜索Jira问题。 |
get_epic_overview |
在一次通话中获得所有子任务、描述和子任务的完整史诗概述。 |
get_active_sprint |
获取当前活动的冲刺,并按状态分组问题。 |
list_sprints |
列出项目板的所有冲刺(未来、活动、关闭)。 |
get_issue_comments |
获取Jira问题的全文评论。 |
get_issue_transitions |
获取Jira问题的可用状态转换。 |
get_issue_changelog |
获取Jira问题的更改历史记录。 |
get_issue_watchers |
获取Jira问题的观察者列表。 |
list_available_tools |
返回当前启用的工具列表。 |
clear_cache |
清除API响应缓存。 |
配置
服务器是通过环境变量(Jira凭据)和可选的JSON配置文件(工具过滤器、项目限制、缓存设置)配置的。
集 MCP_CONFIG_PATH 指向您的配置文件:
export MCP_CONFIG_PATH=./config.json
看 docs/configuration.md 以获取完整的配置参考。
发展
# Run tests
npm test
# Run tests in watch mode
npm run test:watch
# Run tests with coverage
npm run test:coverage
# Lint
npm run lint
# Auto-fix lint issues
npm run lint:fix
# Type-check without emitting
npm run typecheck
# Format code
npm run format
# Validate a config file
npm run validate-config -- --config ./config.json
码头工人
塑造形象:
docker build -t jira-mcp-server .
运行容器:
docker run --rm \
-e JIRA_INSTANCE_URL="https://your-domain.atlassian.net" \
-e JIRA_API_TOKEN="your-api-token" \
-e JIRA_USER_EMAIL="you@example.com" \
jira-mcp-server
挂载配置文件:
docker run --rm \
-e JIRA_INSTANCE_URL="https://your-domain.atlassian.net" \
-e JIRA_API_TOKEN="your-api-token" \
-e JIRA_USER_EMAIL="you@example.com" \
-e MCP_CONFIG_PATH="/app/config/config.json" \
-v ./config.json:/app/config/config.json:ro \
jira-mcp-server
许可证
麻省理工学院