Redmine MCP Server

Redmine MCP Server

site icon
2025.02.17 0
TypeScript团队协作时间跟踪自动化流程交流协作
Redmine MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器实现,专为 Redmine 设计。它通过集成 Redmine 的 REST API,为大型语言模型(LLMs)提供工单和项目信息。该服务器支持从 Redmine REST API 获取稳定的资源,包括问题(Issues)、项目(Projects)、用户(Users)和时间记录(Time Entries)。
View on GitHub

Overview

基本能力

产品定位

Redmine MCP Server 是一个专为 Redmine 设计的 MCP 服务器实现,旨在通过 REST API 为 LLMs 提供工单和项目信息。

核心功能

  • 问题管理:支持搜索、创建、更新和删除问题,可过滤项目、状态、分配者等。
  • 项目管理:支持搜索、获取详情、创建、更新、归档/解归档和删除项目。
  • 时间记录管理:支持搜索、获取详情、创建、更新和删除时间记录。
  • 用户管理:支持列出、创建、更新和删除用户(需要管理员权限)。

适用场景

  • 团队协作:管理项目中的问题和任务。
  • 时间跟踪:记录和跟踪项目时间。
  • 自动化流程:通过 LLMs 自动化处理 Redmine 中的任务。

工具列表

  • Issues 工具:搜索、创建、更新和删除问题。
  • Projects 工具:搜索、获取详情、创建、更新、归档/解归档和删除项目。
  • Time Entries 工具:搜索、获取详情、创建、更新和删除时间记录。

常见问题解答

  • 权限问题:某些用户相关操作需要管理员权限。
  • API 访问:需要启用 REST API 并获取 API 密钥。

使用教程

使用依赖

  • Node.js 18 或更高版本
  • npm 9 或更高版本

安装教程

  1. 获取 API 密钥:
  2. 在 Redmine 管理员设置中启用 REST API。
  3. 从用户设置页面获取 API 密钥。
  4. 设置环境变量: bash export REDMINE_API_KEY="your-api-key-here" export REDMINE_HOST="https://your-redmine.example.com"
  5. 安装并运行: bash npm install npm run build npm run dev

调试方式

  1. 运行单元测试: bash npm test
  2. 使用 MCP Inspector 验证功能: bash npm run build chmod +x dist/index.js npx @modelcontextprotocol/inspector dist/index.js

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。