article
README
🚀 Python Jira MCP 服务器
Python Jira MCP 服务器是一个用 Python 实现的 Model Context Protocol (MCP) 服务器,它集成了 Jira API,允许 AI 模型通过标准化协议与 Jira 进行交互,为 Jira 操作提供了便捷的途径。
🚀 快速开始
Python Jira MCP 服务器将 Jira API 操作作为工具暴露出来,这些工具可供支持 Model Context Protocol 的 AI 模型使用。该服务器实现了 stdio 传输机制,用于与 Cursor 等客户端通信。
✨ 主要特性
- JQL 搜索工具:可使用 JQL 查询搜索 Jira 问题。
- 获取问题工具:能够获取特定 Jira 问题的详细信息。
- MCP SDK 集成:兼容官方 MCP Python SDK。
- 降级模式:在没有 SDK 的情况下提供最小实现。
- 环境配置:支持从环境变量加载 Jira 凭据。
📦 安装指南
- 克隆此仓库:
git clone https://github.com/yourusername/python-jira-mcp.git cd python-jira-mcp - 安装依赖项:
pip install -r requirements.txt - 设置 Jira 凭据:
cp .env.example .env # 在 .env 文件中编辑您的 Jira 凭据
💻 使用示例
基础用法
运行服务器
要启动 MCP 服务器,可运行:
python main.py
或直接使用可执行文件:
./main.py
服务器将开始监听标准输入(stdin)上的 MCP 消息,并通过标准输出(stdout)进行响应。
与 Cursor 集成
要将此 MCP 服务器与 Cursor 结合使用:
- 启动服务器(如上所述)
- 在 Cursor 中配置 MCP 服务器路径指向
main.py - 直接在 Cursor 中使用 Jira 工具
高级用法
JQL 搜索
使用 JQL(Jira 查询语言)搜索 Jira 问题。 示例:
{
"type": "tool_call",
"id": "123",
"name": "jql_search",
"parameters": {
"jql": "project = XYZ AND status = 'In Progress'",
"max_results": 10,
"fields": ["summary", "description", "status"]
}
}
获取问题
通过其 ID 或键检索特定 Jira 问题的详细信息。 示例:
{
"type": "tool_call",
"id": "456",
"name": "get_issue",
"parameters": {
"issue_id_or_key": "XYZ-123",
"fields": ["summary", "description", "status", "assignee"],
"expand": "changelog"
}
}
📚 详细文档
项目结构
- main.py:服务器主程序。
- tools/:包含 Jira 工具的目录。
- requirements.txt:依赖项列表。
- .env.example:示例环境变量文件。
贡献指南
- 克隆仓库:
git clone https://github.com/yourusername/python-jira-mcp.git cd python-jira-mcp - 安装依赖项:
pip install -r requirements.txt - 启动服务器进行测试:
python main.py - 开始开发并提交更改。
📄 许可证
该项目在 LICENSE 下发布。
📞 联系方式
如有任何问题或建议,请联系 your.email@example.com。
微信扫一扫