Redmine MCP 服务器

这是一个为 Redmine 实现的 Model Context Protocol (MCP) 服务器。它通过与 Redmine 的 REST API 集成，向 LLMs 提供票务和项目信息。

功能

支持 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。

设置步骤

1. 安装依赖：

   npm install
   

2. 构建项目：

   npm run build
   

3. 启动开发服务器：

   npm run dev
   

4. 配置环境变量并运行：

   REDMIN_KEY=your_api_key REDMIN_URL=https://your-redmine-instance.com node dist/index.js
   

测试

单元测试

运行以下命令进行单元测试：

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

相关项目

• Model Context Protocol
• MCP TypeScript SDK
• Redmine