Redmine项目管理服务器

Redmine临床MCP服务器

这是一个与Redmine集成的自定义MCP（模型上下文协议）服务器，允许您通过Cline VS Code扩展与您的Redmine项目和问题进行交互。

先决条件

• Node.js： 您的系统上需要安装Node.js（版本18或更高版本）。
• Redmine实例： 您需要一个启用REST API的正在运行的Redmine实例。
• Redmine API密钥： 您的Redmine用户帐户需要一个API密钥。您可以在Redmine帐户设置中找到这一点（通常在“我的帐户”->“API访问密钥”下）。
• 克莱恩： 您需要安装并配置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. 打开临床设置： 在VS Code中，打开Cline扩展并转到MCP Server选项卡。

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。您可以使用 access_mcp_resource Cline中的工具，用于阅读项目的详细信息。例如：

  复制

  <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 （string，必填）：应创建问题的项目的ID。
  • subject （string，必填）：问题的主题。
  • description （string，必填）：问题的描述。

  您可以使用 use_mcp_tool Cline中的工具称此工具。例如：

  复制

  <use_mcp_tool>
  <server_name>redmine-server</server_name>
  <tool_name>create_issue</tool_name>
  <arguments>
  {
    "project_id": "456",
    "subject": "My New Issue",
    "description": "This is a test issue created via Cline."
  }
  </arguments>
  </use_mcp_tool>
  

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

故障排除

• 连接关闭错误： 如果您看到类似“MCP错误-1：连接关闭”的错误，请确保您的 REDMINE_HOST 和 REDMINE_API_KEY 环境变量设置正确。此外，请确保您的Redmine实例可以从您的计算机访问。
• 检查服务器日志： 如果遇到问题，请在VS Code终端中检查服务器的输出是否有任何错误消息。服务器将错误记录到控制台。