🚀 Redmine MCP 服务器
Redmine MCP 服务器是为 Redmine 实现的 Model Context Protocol (MCP) 服务器。它通过与 Redmine 的 REST API 集成，能向大语言模型（LLMs）提供票务和项目信息，助力用户更高效地管理和利用 Redmine 中的数据。
🚀 快速开始
若要使用 Redmine MCP 服务器，可按以下步骤操作：
- 安装依赖：
npm install - 构建项目：
npm run build - 启动开发服务器：
npm run dev - 配置环境变量并运行：
REDMIN_KEY=your_api_key REDMIN_URL=https://your-redmine-instance.com node dist/index.js
✨ 主要特性
支持的稳定资源
本服务器支持 Redmine REST API 的稳定资源，涵盖：
- 问题（1.0~）
- 项目（1.0~）
- 用户（1.1~）
- 工时记录（1.1~）
工具功能
问题管理
- 搜索问题：可按项目、状态、分配人等进行过滤，支持关键字搜索，还能使用自定义字段。
- 创建/更新问题：能设置跟踪器、状态、优先级，配置自定义字段，添加评论。
- 删除问题
项目管理
- 搜索项目：可按激活/已存档/已关闭状态过滤，支持关键字搜索。
- 获取项目详细信息：包含跟踪器、类别信息。
- 创建/更新项目：可配置模块和跟踪器，设置成员继承。
- 存档/取消存档项目
- 删除项目
工时记录管理
- 搜索工时记录：可按项目、用户、日期范围过滤。
- 获取工时记录详细信息
- 创建/更新工时记录：可按项目或用户分配时间。
- 删除工时记录
💻 使用示例
以下是使用此服务器与 Redmine 集成的示例：
{
"command": "npx",
"args": [
"redmine-mcp-server"
],
"env": {
"REDMIN_KEY": "your_api_key_here",
"REDMIN_URL": "https://your-redmine-instance.com"
}
}
📚 详细文档
配置选项
环境变量
REDMIN_KEY：必填项，为 Redmine 的 API 密钥。REDMIN_URL：可选项，默认值为http://localhost:3000，是 Redmine 实例的 URL。
测试
单元测试
运行以下命令进行单元测试：
npm test
Inspector 测试
使用 MCP Inspector 进行测试：
mcp-inspect .
权限注意事项
- 创建/更新/删除问题：需要管理员权限。
- 创建/更新/删除项目：需要管理员权限。
- 创建/更新/删除工时记录：需要管理员或项目负责人权限。
请参考 Redmine 文档以获取更多信息。
开发要求
依赖
- Node.js: v14+
- npm: v6+
构建命令
npm install
npm run build
目录结构
src/
docs/
package.json
tsconfig.json
README.md
📄 许可证
本项目采用 MIT 许可证。