使用说明
Redmine MCP服务器
一种模型上下文协议(MCP)服务器,使Claude Code能够与Redmine项目管理系统进行交互。
特性
此服务器提供五类25个工具:
项目运营
- 列出和检索项目详细信息(支持数字ID和字符串标识符)
- 按名称或标识符搜索项目(部分文本匹配)
- 获取项目成员和权限
问题管理
- 搜索、创建和更新问题(工单)-支持数字项目ID和字符串标识符
- 添加评论,编辑现有评论(
update_issue_journal,需要Redmine 5.0+),并跟踪进度 - 完整或差异(查找和替换)描述更新
- 创建和删除问题之间的关系(依赖关系、阻止程序、重复项等)
- 支持按项目(数字ID或标识符)、跟踪器、状态、受让人和优先级进行筛选
附件
- 上传文件并将其附加到问题、下载、更新元数据(
update_attachment,需要Redmine 3.4+),然后删除
wiki页面
- 列出、阅读(包括旧版本)、创建/更新(完整或差异)和删除wiki页面
元数据
- 列出跟踪器、状态、优先级和用户
- 对于正确创建和更新问题至关重要
无声故障检测
Redmine的REST API以静默方式丢弃工作流或权限规则的字段
不允许(例如,禁止您的角色进行状态转换)
返回HTTP 200。此服务器验证每个 update_issue 呼吁反对
状态Redmine实际上持续存在,并引发了一个显式错误,列出了
丢弃的字段-包括服务器运行时允许的状态转换
报告它们(Redmine 5.0+)。 create_issue 而是返回a warnings 领域
在这种情况下,因为问题本身已经产生,错误可能会导致
重试时重复创建。
安装
先决条件: Python 3.11+, 紫外线 包管理器和启用REST API的Redmine实例。
git clone <repository-url>
cd mcp-redmine
uv sync
配置
获取您的Redmine API密钥
- 登录您的Redmine实例
- 转到“我的帐户”(右上角菜单)
- 点击“API访问密钥”下的“显示”
- 复制API密钥
添加到克劳德代码(推荐)
使用 claude mcp add 命令以轻松配置服务器:
claude mcp add --transport stdio redmine \
--env REDMINE_URL=https://redmine.example.com \
--env REDMINE_API_KEY=your_api_key_here \
-- uv --directory /absolute/path/to/mcp-redmine run mcp-redmine
重要提示: 替换以下内容:
https://redmine.example.com-您的Redmine实例URL(包括https://或http://)your_api_key_here-您的实际Redmine API密钥/absolute/path/to/mcp-redmine-此项目目录的完整路径
添加服务器后重新启动Claude Code。
手动配置
或者,将其添加到您的Claude Code MCP设置文件中(~/.config/claude-code/mcp.json 或类似):
{
"mcpServers": {
"redmine": {
"command": "uv",
"args": [
"--directory",
"/absolute/path/to/mcp-redmine",
"run",
"mcp-redmine"
],
"env": {
"REDMINE_URL": "https://redmine.example.com",
"REDMINE_API_KEY": "your_api_key_here"
}
}
}
}
本地开发
对于本地测试,您可以使用 .env 文件。复制 .env.example 到 .env 并填写你的价值观。请注意,MCP配置 env 部分优先于 .env 文件夹。
用法
配置后,使用Claude Code与Redmine自然交互:
"Show me all open issues in project 5"
"Show me all open issues in the 'mobile-app' project"
"Search for projects related to 'ERP'"
"Create a bug in project 3 titled 'Login page error'"
"Create a bug in the 'backend-api' project titled 'Login timeout'"
"Update issue 123 to 'In Progress' and add a comment"
"Make issue 100 block issue 101"
"Show me the relations for issue 50"
"Who are the members of project 2?"
"What trackers are available?"
Claude将自动使用适当的工具来满足您的请求。项目引用接受两个数字ID(例如。, 5)以及字符串标识符(例如。, "mobile-app")与您的工作流程灵活集成。
故障排除
身份验证错误:
- 验证您的API密钥是否正确
- 检查REST API是否在Redmine中启用(管理→ 设置→ API选项卡)
- 确保您的用户帐户具有适当的权限
连接错误:
- 验证REDMINE_URL与协议(https://或http://)是否正确
- 检查Redmine服务器是否可以从您的网络访问
工具未出现:
- 验证配置中的MCP服务器路径是否绝对正确
- 更改配置后重新启动Claude Code
- 跑
claude mcp list验证服务器是否已注册
局限性
当前版本不支持:
- 时间跟踪条目
- 批量操作
版本相关功能(受Redmine REST API本身限制):
- 编辑现有评论需要Redmine 5.0+(
update_issue_journal) - 更新附件元数据需要Redmine 3.4+(
update_attachment) - 无法更新问题关系(请删除并重新创建)
这些功能可能会根据需求在未来的版本中添加。
许可证
MIT 许可证