logo

RedmineKanban

Login

工作原理

为 AI 客户端提供受控的 Redmine 访问

Model Context Protocol 是一项开放标准,让 AI 客户端通过统一接口使用外部系统提供的工具。Redmine MCP 直接在 Redmine 内提供该接口,无需单独的集成服务。

60+
内置工具
GPL v2+
开源许可证
6.0–7.0
支持的 Redmine 版本

客户端可通过 Redmine MCP 执行的操作

服务器公开专用 MCP 工具,而不是不受限制的数据库访问。可用工具取决于当前用户的权限、项目访问以及已启用的扩展。

项目和成员

列出项目、查看活动和版本、检查模块,并在用户有权限时管理项目成员。

问题和评论

查找、创建和更新问题,添加备注和附件,处理关联、子任务、关注者和类别。

搜索和已保存查询

搜索问题和 Wiki 页面,筛选问题列表,并运行已保存的 Redmine 查询,无需在客户端中重新构建筛选器。

工时跟踪

读取、创建和更新工时记录,查看活动类型,并在一次操作中导入多条记录。

Wiki 和论坛

读取、创建和更新项目 Wiki 页面;浏览论坛、主题和消息线程。

文件和附件

列出项目文件,上传文件和附件,查看附件元数据,并在文档所述限制内下载受支持的附件。

开始使用

安装插件并连接客户端

安装遵循标准的 Redmine 插件流程。管理员启用 MCP 并分配访问权限;每个用户使用自己的 Redmine API 密钥连接。

  1. 1. 安装 Redmine MCP将 git 仓库克隆到 Redmine 插件目录
    cd /path/to/redmine/plugins
    git clone https://github.com/rkteam/redmine_mcp.git
  2. 2. 安装依赖在 Redmine 根目录安装依赖并重启 Redmine
    cd /path/to/redmine
    bundle install
  3. 3. 启用 MCP 和 REST API在插件设置中启用 MCP,并在 Redmine 的 API 设置中启用 REST Web 服务。
  4. 4. 分配访问权限为所需角色启用全局 Use MCP 权限。管理员自动拥有 MCP 访问权限。
  5. 5. 配置客户端将 MCP 服务器 URL 设置为 https://your-redmine.example.com/mcp,并使用用户的 Redmine API 密钥进行身份验证。密钥位于“我的帐户 → API 访问密钥”。
Cursor 配置示例.cursor/mcp.json
{
  "mcpServers": {
    "redmine": {
      "url": "https://your-redmine.example.com/mcp",
      "headers": {
        "X-Redmine-API-Key": "your_api_key"
      }
    }
  }
}

确切的 MCP 配置格式可能因客户端版本而异。请勿将 API 密钥放入版本控制。

访问控制仍由 Redmine 负责

该插件不会绕过 Redmine 的权限模型。MCP 访问不会取代 Redmine 权限和可见性规则;它会增加一次额外的访问检查。

权限和可见性

工具遵守已认证用户现有的 Redmine 权限和可见性规则。

只读模式

管理员可以阻止创建、更新和删除操作,同时保留只读工具。

更安全的写入操作

部分写入操作包含针对冲突更新和意外重复创建资源的保护。

兼容性

Redmine 6.0–7.0 · 需要 REST API

可扩展设计

通过其他 Redmine 插件扩展 MCP

其他 Redmine 插件可以通过 Redmine MCP 扩展 API 注册自己的工具、资源、提示和能力,而无需修改 Redmine MCP 本身。管理员选择启用哪些已检测到的扩展。

Redmine MCP 常见问题

  • Redmine MCP 目前支持 Redmine 6.0–7.0。协议和 SDK 版本请参阅兼容性文档。

  • 任何支持 Streamable HTTP 和自定义 HTTP 标头的 MCP 客户端都可以连接。文档中包含 Cursor 的配置示例。

  • 每个用户通过 X-Redmine-API-Key 标头中的 Redmine API 密钥进行身份验证。必须在 Redmine 中启用 REST API。

  • 是。插件会检查全局 Use MCP 权限,以及已认证用户现有的 Redmine 权限和可见性规则。

  • 是。只读模式会阻止创建、更新和删除操作,同时保留读取工具。

  • 不必。MCP 客户端只需要能访问 Redmine 的 /mcp 端点。连接可以是公开或私有的,取决于客户端的运行位置。

  • 能。其他 Redmine 插件可以通过 Redmine MCP 扩展 API 注册自己的工具、资源、提示和能力。管理员选择启用哪些已检测到的扩展。请参阅扩展指南。

查看源码并安装 Redmine MCP

仓库包含安装步骤、客户端配置、完整工具参考和故障排除说明。