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。

项目贡献

欢迎任何形式的贡献！请随时提交 Pull Request。