article
README
🚀 MCP - JIRA集成
本项目实现了JIRA与MCP(模型上下文协议)的集成,提供了两种集成方式:
- Atlassian官方MCP - 用于基本操作(如查询问题、创建问题等)
- 自定义MCP管理 - 用于管理操作(如创建用户、管理权限等)
🚀 快速开始
配置快速启动
-
运行设置脚本:
.\scripts\setup.ps1 -
在
.env文件中配置您的凭证。 -
启动服务:
.\scripts\start_services.ps1
默认端口
MCP管理服务器按照要求运行在 6000端口。
✨ 主要特性
本项目提供了两种不同的集成方式,分别满足基本操作和管理操作的需求,方便用户在不同场景下使用。
📦 安装指南
前置要求
- Node.js(用于官方MCP)
- Docker Desktop(用于MCP管理)
- PowerShell(用于自动化脚本)
- JIRA凭证:
- JIRA实例的URL
- 用户邮箱
- API令牌
- 管理API密钥(用于管理操作)
- 组织ID
📚 详细文档
项目结构
MCP-Jira/
├── config/
│ ├── claude_desktop_config.json # Claude桌面版配置
│ ├── mcp_config.json # 通用MCP配置
│ └── environment.example.env # 环境变量示例
├── docker/
│ ├── Dockerfile # MCP管理的容器
│ ├── docker-compose.yml # 服务编排
│ └── requirements.txt # Python依赖项
├── src/
│ ├── mcp_admin_server.py # 用于管理操作的MCP服务器
│ ├── tools/ # 自定义MCP工具
│ └── utils/ # 实用工具和辅助函数
├── scripts/
│ ├── setup.ps1 # 初始配置脚本
│ ├── start_services.ps1 # 启动服务
│ └── stop_services.ps1 # 停止服务
└── docs/
├── setup_guide.md # 配置指南
└── api_reference.md # API参考文档
文档说明
docs/setup_guide.md:提供了详细的配置指南,帮助您完成项目的初始配置。docs/api_reference.md:包含了项目中API的参考信息,方便您进行开发和使用。
微信扫一扫