Redmine MCP 服务器用于 Cline

这是一个自定义的MCP（Model Context Protocol）服务器，它与Redmine集成，允许您通过Cline VS Code扩展程序与您的Redmine项目和问题进行交互。

先决条件

• Node.js: 您需要在系统上安装Node.js（版本18或更新版本）。
• Redmine 实例: 您需要一个启用了REST API的正在运行的Redmine实例。
• Redmine API密钥: 您需要为您的Redmine用户账户获取一个API密钥。您可以在Redmine账户设置中找到这个密钥（通常位于“我的账户” -> “API访问密钥”下）。
• Cline: 您需要安装并配置Cline VS Code扩展。

安装

1. 克隆仓库:

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

2. 安装依赖:

   npm install
   

配置

1. 设置环境变量:
   在项目的根目录创建一个.env文件，并添加以下内容，将占位符替换为您实际的Redmine主机名和API密钥：

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

   重要: 不要将您的.env文件提交到版本控制！它包含敏感信息。此仓库中包含的.gitignore文件应防止其被提交。

添加至Cline

1. 打开Cline设置: 在VS Code中，打开Cline扩展并转到MCP服务器标签页。

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

3. 添加服务器: 向mcpServers对象中添加以下条目，将args路径替换为您系统上的server.js文件的绝对路径：

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

   重要: 在Windows路径中确保使用双反斜杠(\\)。

4. 保存: 保存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中创建一个新的问题。它需要以下参数：

  • project_id (字符串, 必填): 应该创建问题的项目的ID。
  • subject (字符串, 必填): 问题的主题。
  • description (字符串, 必填): 问题的描述。

  你可以在Cline中使用use_mcp_tool工具来调用此工具。例如：

  <use_mcp_tool>
  <server_name>redmine-server</server_name>
  <tool_name>create_issue</tool_name>
  <arguments>
  {
    "project_id": "456",
    "subject": "我的新问题",
    "description": "这是一个通过Cline创建的测试问题。"
  }
  </arguments>
  </use_mcp_tool>
  

  （请将456替换为有效的项目ID）。这将在指定的项目中创建一个新问题，并以JSON格式返回问题详情。

故障排除

• 连接关闭错误: 如果你看到类似于"MCP error -1: Connection closed"的错误，请确保你的REDMINE_HOST和REDMINE_API_KEY环境变量设置正确。同时，确保你的计算机可以访问到Redmine实例。
• 检查服务器日志: 如果遇到问题，请检查VS Code终端中的服务器输出是否有任何错误消息。服务器会将错误记录到控制台。