JinDaGe - Redmine MCP Details

article

README

🚀 Redmine MCP 服务器用于 Cline

这是一个自定义的 MCP（模型上下文协议）服务器，它与 Redmine 集成，让您能够通过 Cline VS Code 扩展与 Redmine 项目和问题进行交互，为您的项目管理工作提供便利。

🚀 快速开始

在使用 Redmine MCP 服务器之前，您需要完成一系列准备工作，包括安装必要的软件、获取相关密钥以及配置环境等。

✨ 主要特性

与 Redmine 深度集成，可通过 Cline VS Code 扩展与 Redmine 项目和问题交互。
支持通过特定 URI 访问项目。
可使用 JSON 配置在项目中创建问题。

📦 安装指南

克隆仓库

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

安装依赖项

npm install

📚 详细文档

先决条件

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

配置

设置环境变量

在项目根目录下创建一个 .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 对象中，用路径的绝对路径替换 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 应自动检测更改并启动服务器。

资源和工具

资源

使用以下 URI 访问项目：

redmine://projects
redmine://projects/{project_id}

工具

使用以下 JSON 配置在项目中创建问题：

{
  "subject": "问题主题",
  "description": "问题描述"
}

故障排除

连接关闭错误：确保 Redmine 实例的 REST API 已启用，并且您的 API 密钥正确。
检查服务器日志：如果遇到问题，检查 MCP 服务器的日志文件以获取更多信息。

希望这份指南对您使用 Redmine MCP 服务器有所帮助！

Redmine