Yonaka15 MCP Server Redmine

🚀 Redmine MCP 服務器

Redmine MCP 服務器是為 Redmine 實現的 Model Context Protocol (MCP) 服務器。它通過與 Redmine 的 REST API 集成，能向大語言模型（LLMs）提供票務和項目信息，助力用戶更高效地管理和利用 Redmine 中的數據。

🚀 快速開始

若要使用 Redmine MCP 服務器，可按以下步驟操作：

1. 安裝依賴：

   npm install
   

2. 構建項目：

   npm run build
   

3. 啟動開發服務器：

   npm run dev
   

4. 配置環境變量並運行：

   REDMIN_KEY=your_api_key REDMIN_URL=https://your-redmine-instance.com node dist/index.js
   

✨ 主要特性

支持的穩定資源

本服務器支持 Redmine REST API 的穩定資源，涵蓋：

• 問題（1.0~）
• 項目（1.0~）
• 用戶（1.1~）
• 工時記錄（1.1~）

工具功能

問題管理

• 搜索問題：可按項目、狀態、分配人等進行過濾，支持關鍵字搜索，還能使用自定義字段。
• 創建/更新問題：能設置跟蹤器、狀態、優先級，配置自定義字段，添加評論。
• 刪除問題

項目管理

• 搜索項目：可按激活/已存檔/已關閉狀態過濾，支持關鍵字搜索。
• 獲取項目詳細信息：包含跟蹤器、類別信息。
• 創建/更新項目：可配置模塊和跟蹤器，設置成員繼承。
• 存檔/取消存檔項目
• 刪除項目

工時記錄管理

• 搜索工時記錄：可按項目、用戶、日期範圍過濾。
• 獲取工時記錄詳細信息
• 創建/更新工時記錄：可按項目或用戶分配時間。
• 刪除工時記錄

💻 使用示例

以下是使用此服務器與 Redmine 集成的示例：

{
  "command": "npx",
  "args": [
    "redmine-mcp-server"
  ],
  "env": {
    "REDMIN_KEY": "your_api_key_here",
    "REDMIN_URL": "https://your-redmine-instance.com"
  }
}

📚 詳細文檔

配置選項

環境變量

• REDMIN_KEY：必填項，為 Redmine 的 API 密鑰。
• REDMIN_URL：可選項，默認值為 http://localhost:3000，是 Redmine 實例的 URL。

測試

單元測試

運行以下命令進行單元測試：

npm test

Inspector 測試

使用 MCP Inspector 進行測試：

mcp-inspect .

權限注意事項

• 創建/更新/刪除問題：需要管理員權限。
• 創建/更新/刪除項目：需要管理員權限。
• 創建/更新/刪除工時記錄：需要管理員或項目負責人權限。

請參考 Redmine 文檔以獲取更多信息。

開發要求

依賴

• Node.js: v14+
• npm: v6+

構建命令

npm install
npm run build

目錄結構

src/
docs/
package.json
tsconfig.json
README.md

📄 許可證

本項目採用 MIT 許可證。

🔗 相關項目

• Model Context Protocol
• MCP TypeScript SDK
• Redmine