Jira Insight MCP管理器
一个MCP服务器,允许通过模型上下文协议对Jira Insights(JSM)资产模式进行管理,支持对象模式、对象类型和对象的CRUD操作。
服务介绍
Jira Insights MCP
用于管理 Jira Insights (JSM) 资产架构的模型上下文协议 (MCP) 服务器。
最后更新时间:2025-04-09
概述
此 MCP 服务器通过模型上下文协议提供了与 Jira Insights (JSM) 资产架构交互的工具。它允许您管理 Jira Insights 中的对象架构、对象类型和对象。
功能
- 管理对象架构(创建、读取、更新、删除)
- 管理对象类型(创建、读取、更新、删除)
- 管理对象(创建、读取、更新、删除)
- 使用 AQL(Atlassian 查询语言)查询对象
前提条件
- Node.js 20 或更高版本
- Docker(用于容器化部署)
- 具有 API 访问权限的 Jira Insights 实例
- 具有适当权限的 Jira API 令牌
安装
本地开发
-
克隆仓库:
git clone https://github.com/aaronsb/jira-insights-mcp.git cd jira-insights-mcp -
安装依赖项:
npm install -
构建项目:
npm run build
Docker
构建 Docker 镜像:
./scripts/build-local.sh
使用
MCP 配置
要将此 MCP 服务器与 Claude 或其他支持模型上下文协议的 AI 助手一起使用,请使用以下方法之一将其添加到您的 MCP 配置中:
本地构建配置
如果您已本地构建项目,请使用此配置:
{
"mcpServers": {
"jira-insights": {
"command": "node",
"args": ["/path/to/jira-insights-mcp/build/index.js"],
"env": {
"JIRA_API_TOKEN": "your-api-token",
"JIRA_EMAIL": "your-email@example.com",
"JIRA_HOST": "https://your-domain.atlassian.net",
"LOG_MODE": "strict"
}
}
}
}
基于 Docker 的配置
如果您更喜欢使用 Docker 镜像(推荐大多数用户使用),请使用此配置:
{
"mcpServers": {
"jira-insights": {
"command": "docker",
"args": [
"run",
"--rm",
"-i",
"-e", "JIRA_API_TOKEN",
"-e", "JIRA_EMAIL",
"-e", "JIRA_HOST",
"ghcr.io/aaronsb/jira-insights-mcp:latest"
],
"env": {
"JIRA_API_TOKEN": "your-api-token",
"JIRA_EMAIL": "your-email@example.com",
"JIRA_HOST": "https://your-domain.atlassian.net"
}
}
}
}
此基于 Docker 的配置从 GitHub Container Registry 拉取最新镜像并运行,同时设置了必要的环境变量。
本地开发运行
对于本地开发和测试:
# Build the Docker image
./scripts/build-local.sh
# Run the Docker container
JIRA_API_TOKEN=your_token JIRA_EMAIL=your_email JIRA_HOST=your_host ./scripts/run-local.sh
可用工具
manage_jira_insight_schema
使用 CRUD 操作管理 Jira Insights 对象架构。
{
"operation": "list",
"maxResults": 10
}
manage_jira_insight_object_type
使用 CRUD 操作管理 Jira Insights 对象类型。
{
"operation": "list",
"schemaId": "1",
"maxResults": 20
}
manage_jira_insight_object
使用 CRUD 操作和 AQL 查询管理 Jira Insights 对象。
{
"operation": "query",
"aql": "objectType = \"Application\"",
"maxResults": 10
}
可用资源
MCP 服务器提供了多个资源来访问 Jira Insights 数据:
jira-insights://instance/summary- 关于 Jira Insights 实例的高级统计信息jira-insights://aql-syntax- 包含示例的 Assets Query Language (AQL) 语法综合指南jira-insights://schemas/all- 包含其对象类型的全部架构列表jira-insights://schemas/{schemaId}/full- 包括对象类型的特定架构的完整定义jira-insights://schemas/{schemaId}/overview- 包括元数据和统计信息的特定架构概述jira-insights://object-types/{objectTypeId}/overview- 包括属性和统计信息的特定对象类型概述
计划中的改进
我们正在努力进行多项改进,以增强 Jira Insights MCP 的功能性和易用性:
高优先级改进
-
增强错误处理
- 更详细的错误信息,包含具体的验证问题
- 对常见错误的建议修复
- 与操作相关的示例,帮助用户纠正问题
-
AQL 查询改进
- AQL 查询的验证和格式化工具
- 针对特定模式的示例查询
- 更好的查询错误信息
-
属性发现增强
- 改进对象类型的属性检索
- 使用缓存以提高性能
- 更好地处理“expand”参数
中等优先级改进
-
对象模板生成
- 基于对象类型创建对象的模板
- 特定类型的占位符生成
- 模板中的验证规则
-
示例查询库
- 针对特定模式的示例查询
- 上下文感知的查询建议
- 常见操作的查询模板
-
改进文档
- 增强的 AQL 语法文档
- 与操作相关的文档
- 常见错误场景及解决方案
有关计划改进的更多详细信息,请参阅:
TODO.md- 包含按优先级组织的所有任务的全面待办事项列表IMPLEMENTATION_PLAN.md- 高优先级改进的详细实施计划HANDLER_IMPROVEMENTS.md- 每个处理器文件所需的特定更改IMPROVEMENT_SUMMARY.md- 计划改进的简明摘要docs/API_MIGRATION_TODO.md- API 迁移的状态和计划改进
开发
脚本
npm run build: 构建 TypeScript 代码npm run lint: 运行 ESLintnpm run lint:fix: 自动修复运行 ESLintnpm run test: 运行测试npm run watch: 监视更改并重建npm run generate-diagrams: 生成 TypeScript 依赖图
Docker 脚本
./scripts/build-local.sh: 构建 Docker 镜像./scripts/run-local.sh: 运行 Docker 容器
故障排除
常见问题
-
AQL 查询验证错误
- 确保带有空格的值用引号括起来:
Name = "John Doe" - 逻辑运算符使用大写:
AND,OR(而不是and,or) - 检查您的模式中是否存在对象类型和属性
- 确保带有空格的值用引号括起来:
-
对象类型属性问题
- 当使用带有“attributes”的“expand”参数时,确保对象类型存在
- 检查您是否有权限查看这些属性
-
API 连接问题
- 确认您的 Jira API 令牌具有必要的权限
- 检查 Jira 主机 URL 是否正确
- 确保您的网络允许连接到 Jira API
许可证
MIT