Mcp Redmine

Redmine MCP 服务

一个模型上下文协议（MCP）服务，可与 Redmine 项目管理软件无缝集成。该服务提供一套全面的工具，用于管理项目、问题、用户、工时跟踪等，让 AI 助手能够与 Redmine 交互。

🎯 兼容性

兼容 Redmine 4.1.1.stable

此 MCP 服务专为 Redmine 4.1.1.stable 开发并经过测试。虽然它可能适用于其他版本，但此版本可确保实现最佳功能。

功能

项目管理

• 列出、创建、更新和删除项目
• 管理项目版本和路线图
• 处理问题类别

问题跟踪

• 全面的​​问题 CRUD 操作
• 高级筛选和搜索功能
• 问题分配和状态管理
• 进度跟踪和工时估算

用户管理

• 列出用户并获取用户详情
• 当前用户信息
• 将用户分配给问题

工时跟踪

• 创建并列出工时条目
• 将工时关联到问题或项目
• 按活动记录工时

系统信息

• 列出可用的跟踪器
• 获取问题状态和优先级
• 系统配置详情

安装

自动安装（推荐）

在 PowerShell（Windows）中运行以下命令：

./install-mcp-redmine.ps1

此脚本将：

• 安装所有依赖项
• 构建项目
• 如果 .env 文件不存在，则创建该文件
• 打包并全局安装 MCP Redmine

安装后，编辑 .env 文件并填写 Redmine 服务详情：

REDMINE_BASE_URL=https://your-redmine-server.com
REDMINE_API_KEY=your_api_key_here

手动安装步骤请参阅 DEVELOPMENT.md

用法

开发

在开发模式下运行并启用自动重新加载：

npm run dev

生产

构建并运行服务：

npm run build
npm start

配置

该服务支持多种身份验证方式。请配置以下方式之一：

选项 1：API 密钥（推荐）

• REDMINE_BASE_URL：Redmine 服务 URL
• REDMINE_API_KEY：Redmine API 密钥

选项 2：用户名/密码

• REDMINE_BASE_URL：Redmine 服务 URL
• REDMINE_USERNAME：Redmine 用户名
• REDMINE_PASSWORD：Redmine 密码

可选配置：

• REDMINE_IMPERSONATE_USER：要模拟的用户名（需要管理员权限）

可用工具

项目工具

• list_projects：列出所有项目，可选筛选
• get_project：获取指定项目的详情
• create_project：创建新项目
• update_project：更新现有项目
• delete_project：删除项目

问题工具

• list_issues：列出问题，支持丰富的筛选选项
• get_issue：获取指定问题的详情
• create_issue：创建新问题
• update_issue：更新现有问题
• delete_issue：删除问题

问题关联

• list_issue_relations：列出指定问题的所有关联
• create_issue_relation：创建问题之间的关联（相关、重复、阻塞等）
• delete_issue_relation：删除问题关联

管理工具

• list_users：列出所有用户
• get_user：获取指定用户的详情
• get_current_user：获取当前已通过身份验证的用户
• list_trackers：列出问题跟踪器
• list_issue_statuses：列出可用的问题状态
• list_issue_priorities：列出问题优先级

高级管理工具

• list_roles：列出 Redmine 中的所有角色
• list_groups：列出所有用户组
• get_group：获取指定用户组的详情及其用户
• create_group：创建用户组
• list_project_memberships：列出项目成员关系
• create_project_membership：将用户/用户组添加到项目并分配角色
• list_time_entry_activities：列出可用的工时条目活动

项目管理工具

• list_time_entries：列出时间条目并进行筛选
• create_time_entry：记录问题或项目的耗时
• list_versions：列出项目版本
• create_version：创建新的项目版本
• list_issue_categories：列出问题类别
• create_issue_category：创建新的问题类别

Wiki 管理

• list_wiki_pages：列出项目的所有 Wiki 页面
• get_wiki_page：获取特定 Wiki 页面的内容
• create_wiki_page：创建或更新 Wiki 页面
• delete_wiki_page：删除 Wiki 页面

搜索和文件

• search：搜索所有 Redmine 内容（需要 Redmine 3.3+）
• upload_file：上传文件并获取用于添加附件的令牌
• get_attachment：获取附件详情
• list_news：列出新闻文章
• list_queries：列出已保存的查询

MCP 集成

要将此服务与 MCP 客户端配合使用，请按如下方式配置：

{
  "servers": {
    "redmine": {
      "type": "stdio",
      "command": "node",
      "args": ["dist/index.js"]
    }
  }
}

开发

项目结构

src/
├── index.ts                    # Main server entry point
├── client/
│   └── redmine-client.ts      # Redmine API client
├── tools/
│   ├── project-tools.ts       # Project management tools
│   ├── issue-tools.ts         # Issue tracking tools
│   ├── admin-tools.ts         # Administrative tools
│   └── project-management-tools.ts # Time tracking and versioning
└── types/
    └── redmine.ts             # TypeScript type definitions

构建

npm run build

使用自动重新加载进行开发

npm run dev

API 密钥设置

1. 登录 Redmine 实例
2. 前往“My account”（右上角菜单）
3. 点击右侧边栏中的“API access key”
4. 点击“Show”以显示 API 密钥
5. 将此密钥复制到 .env 文件中

要求

• Node.js 18 或更高版本
• 已启用 REST API 的 Redmine 4.0+
• 有效的 Redmine API 密钥

许可证

MIT

贡献

1. Fork 此仓库
2. 创建功能分支
3. 进行更改
4. 如适用，添加测试
5. 提交拉取请求

支持

如有问题或疑问：

• 查看 Redmine API 文档
• 查看 MCP 规范
• 在此仓库中提交问题