Redmine MCP Server For Cline

🚀 Redmine MCP 服务器（适用于 Cline）

这是一个自定义的 MCP（模型上下文协议）服务器，它与 Redmine 集成，让您能够借助 Cline VS Code 扩展与 Redmine 项目及问题进行交互，提升项目开发与管理的效率。

🚀 快速开始

先决条件

• Node.js：您的系统需要安装 Node.js（版本 18 或更高）。
• Redmine 实例：需有一个运行中的 Redmine 实例，并且要启用 REST API。
• Redmine API 密钥：您要为 Redmine 用户账户获取一个 API 密钥，可在 Redmine 账户设置（通常在“我的账户” -> “API 访问密钥”）中找到。
• Cline：需安装并配置好 Cline VS Code 扩展。

📦 安装指南

克隆仓库

git clone https://github.com/ilask/Redmine-MCP.git
cd Redmine-MCP

安装依赖项

npm install

📚 详细文档

配置

设置环境变量

在项目根目录下创建一个 .env 文件，并添加以下内容，用实际的 Redmine 主机名和 API 密钥替换占位符：

REDMINE_HOST=your-redmine-host.com
REDMINE_API_KEY=your-redmine-api-key

⚠️ 重要提示

请勿将 .env 文件提交到版本控制，它包含敏感信息。此存储库中包含的 .gitignore 文件会阻止其被提交。

添加到 Cline

打开 Cline 设置

在 VS Code 中，打开 Cline 扩展并转到“MCP 服务器”选项卡。

编辑 MCP 设置

点击“编辑 MCP 设置”以打开 cline_mcp_settings.json 文件。

添加服务器

将以下条目添加到 mcpServers 对象中，用实际的 server.js 文件的绝对路径替换 args 中的路径：

{
  "mcpServers": {
    "redmine-server": {
      "command": "node",
      "args": ["C:\\Users\\yourusername\\path\\to\\Redmine-MCP\\server.js"],
      "disabled": false,
      "autoApprove": []
    }
  }
}

⚠️ 重要提示

确保在 Windows 上使用双反斜杠（\\）。

保存

保存 cline_mcp_settings.json 文件。Cline 应该会自动检测更改并启动服务器。

可用资源和工具

资源

• redmine://projects/{project_id}：此资源表示 Redmine 项目。将 {project_id} 替换为实际的 Redmine 实例中的项目 ID。您可以通过 Cline 的 access_mcp_resource 工具读取项目的详细信息。例如：

<access_mcp_resource>
<server_name>redmine-server</server_name>
<uri>redmine://projects/123</uri>
</access_mcp_resource>

（将 123 替换为有效的项目 ID）。这将返回项目的详细信息作为 JSON。

工具

• create_issue：此工具允许您在 Redmine 中创建新问题。它接受以下参数：

  • title（必填）：问题的标题。
  • description（可选）：问题的描述。
  • project_id（可选）：项目的 ID。

  示例：

POST http://localhost:3000/api/mcp
Content-Type: application/json

{
  "command": "create_issue",
  "params": {
    "title": "这是一个测试问题",
    "description": "这是问题的描述。",
    "project_id": "123"
  }
}

故障排除

• 检查 Node.js 版本：确保您使用的是兼容版本（Node.js 18 或更高）。
• 查看日志：如果出现问题，检查服务器的控制台输出以获取更多信息。
• 重新加载 Cline 设置：在添加或修改配置后，确保重新加载 Cline 扩展以应用更改。

通过以上步骤，您可以轻松地将 Redmine 集成到您的项目中，并利用 Cline 进行高效的开发和管理。