Redmine MCP Server

🚀 Redmine MCP 服務器

Redmine MCP 服務器是一個模型上下文協議（MCP）服務器，它能讓 AI 助手與 Redmine 進行交互，助力實現專注且透明的項目管理。

🚀 快速開始

此 MCP 服務器在 AI 助手和 Redmine 之間搭建了溝通的橋樑，讓 AI 能夠：

• 創建和更新帶正確分類的問題
• 管理 wiki 頁面和文檔
• 跟蹤項目狀態和進度
• 遵循定義的流程以確保一致性

藉助這個 MCP 服務器，您可以確保 AI 工作專注、記錄完善，並且能完全透明地向人類團隊成員公開。

✨ 主要特性

資源能力

• 問題：可訪問 Redmine 問題，還具備篩選和搜索功能。
• 項目：能訪問項目數據、類別和狀態。
• Wiki：可訪問 wiki 頁面的文檔資源。

工具能力

• create_issue：創建新的問題，並進行正確分類。
• update_issue：更新現有問題的狀態和備註。
• create_wiki：創建或更新 wiki 頁面以進行文檔記錄。
• get_project_status：獲取項目狀態摘要和統計信息。

提示能力

• issue_template：提供創建結構良好問題的模板。
• wiki_template：提供創建結構良好 wiki 頁面的模板。

📦 安裝指南

安裝需求

• Python 3.9+
• Flask
• 具有 API 訪問權限的 Redmine 實例
• Claude Desktop 或其他 MCP 兼容 AI 助手

安裝步驟

1. 克隆倉庫：

git clone https://github.com/yourusername/redmine-mcp-server.git
cd redmine-mcp-server

2. 安裝依賴項：

pip install -r requirements.txt

3. 配置服務器：

cp config.yaml.example config.yaml
# 使用您的 Redmine URL 和 API 令牌編輯 config.yaml

💻 使用示例

運行服務器

使用以下命令啟動服務器：

python main.py

服務器默認在端口 5000 上運行。

Docker 部署

構建並運行 Docker 容器：

docker build -t redmine-mcp-server .
docker run -d -p 5000:5000 -e REDMINE_API_KEY=your_api_key -e REDMINE_URL=http://localhost:3000 redmine-mcp-server

配置 Claude Desktop

將以下內容添加到您的 Claude Desktop MCP 配置中：

{
  "mcps": {
    "redmine": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "REDMINE_API_KEY",
        "-e",
        "REDMINE_URL",
        "redmine-mcp-server"
      ]
    }
  }
}

📚 詳細文檔

API 參考

資源

• 獲取 /mcp
  • 描述：返回 MCP 服務器的狀態。
  • 方法：GET
  • URL：/mcp

狀態

• 獲取 /projects/{project_id}
  • 描述：返回指定項目的狀態信息。
  • 方法：GET
  • URL：/projects/{project_id}

配置選項

以下環境變量可用於配置 MCP 服務器：

流程優勢

1. 專注：AI 工作按類別和流程執行，確保效率。
2. 記錄良好：所有 AI 行為都被日誌記錄以便審查。
3. 透明度：團隊成員可以輕鬆查看和貢獻 AI 工作。
4. 協作：人類團隊成員可以直接在 Redmine 中與 AI 工作交互。
5. 進度跟蹤：項目經理可以通過 Redmine 跟蹤 AI 任務的進展。

📄 許可證

本項目採用 MIT License。

🔧 技術細節

本項目的流程具有顯著優勢，能確保 AI 工作的高效性、可審查性、透明度、協作性以及便於進度跟蹤。同時，通過配置相應的環境變量，可以靈活地對 MCP 服務器進行配置，以適應不同的使用場景。

項目貢獻

歡迎任何貢獻！請隨時提交 Pull Request。