Redmine MCP 服务器

一个模型上下文协议（MCP）服务器，使AI助手能够与Redmine项目管理系统进行交互。此服务器提供了对Redmine功能的全面访问，包括问题、项目、时间跟踪、用户和维基页面。

功能

问题管理

• 列出、搜索和筛选问题
• 创建、更新和删除问题
• 查看带有关系和历史的问题详情

项目管理

• 列出所有项目
• 查看项目详情和元数据
• 访问项目版本/里程碑

时间跟踪

• 登记时间条目
• 查看和管理时间记录
• 列出时间条目活动

用户管理

• 列出用户和组
• 获取用户详情和成员资格
• 访问当前用户信息

维基管理

• 列出具有层次结构的维基页面
• 创建、更新和删除维基页面
• 查看维基页面历史

实用工具

• 列出问题状态、优先级和追踪器
• 高级用例的自定义API请求
• 搜索问题、维基页面等

先决条件

• Node.js >= 20.0.0
• 启用了API访问的Redmine实例
• Redmine API密钥或用户名/密码

安装

全局安装（推荐）

npm install -g @gmlee-ncurity/mcp-server-redmine

直接使用（无需安装）

npx @gmlee-ncurity/mcp-server-redmine

本地开发

# 克隆仓库
git clone https://github.com/gmlee-ncurity/redmine-mcp-server.git
cd redmine-mcp-server

# 安装依赖
npm install

# 构建项目
npm run build

配置

环境变量

通过环境变量在您的MCP客户端配置中设置服务器：

# 必需
REDMINE_URL=https://your-redmine-instance.com
REDMINE_API_KEY=your-api-key-here

# 可选：基本认证（如果未使用API密钥）
# REDMINE_USERNAME=your-username
# REDMINE_PASSWORD=your-password

# 可选：SSL配置
# REDMINE_SSL_VERIFY=true
# REDMINE_CA_CERT=/path/to/ca.crt

# 可选：请求配置
# REDMINE_REQUEST_TIMEOUT=30000
# REDMINE_MAX_RETRIES=3

获取Redmine API密钥

1. 登录到您的Redmine实例
2. 转到“我的账户”（右上角）
3. 在侧边栏点击“API访问密钥”
4. 点击“显示”以揭示您的API密钥
5. 在您的MCP配置中使用API密钥

与Claude Desktop一起使用

使用已发布的包

添加到您的Claude Desktop配置（macOS上的~/Library/Application Support/Claude/claude_desktop_config.json）：

{
  "mcpServers": {
    "redmine": {
      "command": "npx",
      "args": ["-y", "@gmlee-ncurity/mcp-server-redmine"],
      "env": {
        "REDMINE_URL": "https://your-redmine-instance.com",
        "REDMINE_API_KEY": "your-api-key-here"
      }
    }
  }
}

使用本地开发版本

{
  "mcpServers": {
    "redmine": {
      "command": "node",
     
      "args": ["/path/to/redmine-mcp-server/dist/index.js"],
      "env": {
        "REDMINE_URL": "https://your-redmine-instance.com",
        "REDMINE_API_KEY": "your-api-key-here"
      }
    }
  }
}

与VS Code一起使用

您可以使用支持模型上下文协议的VS Code扩展来使用此MCP服务器。以下是配置方法：

使用Cline（Claude Dev）扩展

1. 从VS Code市场安装Cline扩展
2. 打开VS Code设置（Cmd/Ctrl + ,）
3. 搜索"Cline MCP"
4. 添加Redmine服务器配置：

{
  "cline.mcpServers": {
    "redmine": {
      "command": "npx",
      "args": ["-y", "@gmlee-ncurity/mcp-server-redmine"],
      "env": {
        "REDMINE_URL": "https://your-redmine-instance.com",
        "REDMINE_API_KEY": "your-api-key-here"
      }
    }
  }
}

使用其他兼容MCP的扩展

查阅扩展的文档以获取MCP服务器配置。通常模式类似于上述内容。

可用工具

问题工具

• redmine_list_issues - 列出问题并应用过滤器
• redmine_get_issue - 获取问题详情
• redmine_create_issue - 创建新问题
• redmine_update_issue - 更新现有问题
• redmine_delete_issue - 删除问题

项目工具

• redmine_list_projects - 列出所有项目
• redmine_get_project - 获取项目详情
• redmine_get_project_versions - 获取项目版本

用户工具

• redmine_list_users - 列出用户
• redmine_get_current_user - 获取当前用户信息
• redmine_get_user - 获取特定用户的详情

时间条目工具

• redmine_list_time_entries - 列出时间条目
• redmine_get_time_entry - 获取时间条目详情
• redmine_create_time_entry - 创建时间条目
• redmine_update_time_entry - 更新时间条目
• redmine_delete_time_entry - 删除时间条目
• redmine_list_time_entry_activities - 列出活动

维基工具

• redmine_list_wiki_pages - 列出维基页面
• redmine_get_wiki_page - 获取维基页面内容
• redmine_create_or_update_wiki_page - 创建/更新维基页面
• redmine_delete_wiki_page - 删除维基页面

实用工具

• redmine_list_statuses - 列出问题状态
• redmine_list_priorities - 列出问题优先级
• redmine_list_trackers - 列出问题追踪器
• redmine_custom_request - 发送自定义API请求
• redmine_search - 搜索问题、维基页面等

示例查询

一旦配置完成，您可以向您的AI助手提问如下：

• "展示分配给我的所有开放问题"
• "为API项目创建一个新的错误报告"
• "记录今天在问题#123上工作的2小时"
• "列出我有权访问的所有项目"
• "展示关于部署过程的维基页面"
• "本周更新了哪些问题？"
• "更新问题#456，将其优先级设为高"

开发

本地运行

# 安装依赖
npm install

# 开发模式运行
npm run dev

# 运行测试
npm test

# 生产构建
npm run build

使用MCP Inspector调试

npm run inspector

这将在http://localhost:5173启动MCP Inspector

安全注意事项

• 始终使用HTTPS作为您的Redmine URL
• 安全存储API密钥，并且永远不要将其提交到版本控制中
• 使用环境变量存储敏感配置
• 当不需要写入权限时，考虑使用只读API密钥
• 在生产环境中实现正确的SSL证书验证

故障排除

连接问题

• 验证您的Redmine URL是否可访问
• 检查Redmine设置中是否启用了API
• 确保您的API密钥具有必要的权限

认证错误

• 确认您的API密钥有效且处于激活状态
• 如果使用基本认证，请验证用户名和密码
• 检查您的用户账户是否处于激活状态

SSL/TLS问题

• 对于自签名证书，设置REDMINE_SSL_VERIFY=false（不建议用于生产环境）
• 通过REDMINE_CA_CERT提供CA证书路径

桌面扩展（DXT）支持

此MCP服务器也打包为桌面扩展（DXT），以便与支持的应用程序无缝集成：

# 构建DXT包
npm run build:bundle

捆绑版本包括所有依赖项，并经过优化以供分发。

开发与发布

自动化发布流程

该项目包含自动化发布脚本，便于版本管理和发布：

# 发布补丁版本（1.0.1 -> 1.0.2）
npm run release

# 发布次要版本（1.0.1 -> 1.1.0）
npm run release:minor

# 发布主要版本（1.0.1 -> 2.0.0）
npm run release:major

# 或直接使用脚本并带选项
./scripts/release.sh minor --skip-tests

自动化发布流程：

1. 🔄 在package.json中更新版本
2. ✅ 在适当环境下运行所有测试
3. 🔍 运行代码检查
4. 🔨 构建项目
5. 📝 提交标准化消息更改
6. 🚀 推送到仓库
7. 📦 发布到npm注册表
8. 🏷️ 创建GitHub发行版（如果可用gh CLI）

CI/CD流水线

GitHub Actions自动执行以下操作：

• 在Node.js 20.x和22.x上运行测试
• 检查代码质量和构建
• 当版本变化时自动发布到npm
• 创建GitHub发行版
• 上传测试覆盖率报告

贡献

欢迎贡献！请阅读我们的贡献指南并提交拉取请求到我们的仓库。

许可证

本项目根据Apache许可证2.0发布 - 详情见LICENSE文件。 </中文翻译>