article
README
🚀 Jira MCP 服务器
Jira MCP 服务器是一个用于 Jira 集成的 Model Context Protocol(MCP)服务器实现,它允许 AI 模型通过标准化接口与 Jira 进行交互,为 Jira 与 AI 模型的连接提供了便利。
✨ 主要特性
- 完整的 Jira REST API 集成,实现与 Jira 的全面交互。
- 采用连接池以获得最佳性能,提升系统响应速度。
- 具备全面的错误处理机制,保障系统稳定性。
- 类型安全的实现,减少开发中的错误。
- 内置速率限制,防止系统过载。
- 支持请求日志记录和监控,方便进行系统运维。
📦 安装指南
使用以下命令安装 Jira MCP 服务器:
npm install @modelcontextprotocol/server-jira
📚 详细文档
配置
该服务器需要以下环境变量:
JIRA_HOST=your-domain.atlassian.net
JIRA_API_TOKEN=your-api-token
JIRA_EMAIL=your-email@domain.com
PORT=3000 # 可选,默认为 3000
POOL_SIZE=10 # 可选,默认为 10
使用
启动服务器
# 开发模式
npm run dev
# 生产模式
npm run build
npm start
API 端点
GET /health- 健康检查端点,用于检查服务器是否正常运行。GET /api/v1/issues/:issueKey- 获取问题详情。GET /api/v1/sprint/current- 获取当前冲刺详情。GET /api/v1/analytics/workload- 获取工作量分析。
开发
先决条件
- Node.js 14 或更高版本。
- npm 6 或更高版本。
设置
- 克隆仓库。
- 安装依赖:
npm install。 - 设置环境变量。
- 启动开发服务器:
npm run dev。
测试
# 运行测试
npm test
# 运行代码检查工具
npm run lint
# 格式化代码
npm run format
贡献
请阅读 CONTRIBUTING.md 以了解我们的行为准则和提交拉取请求的流程。
📄 许可证
该项目在 MIT 许可证下发布,详细信息见 LICENSE 文件。
微信扫一扫