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 進行高效的開發和管理。