Redmine MCP 服务器

这是一个为 Redmine 实现的 Model Context Protocol (MCP) 服务器。它与 Redmine 的 REST API 集成，向 LLMs 提供工单和项目信息。

特性

支持来自 Redmine REST API 的稳定资源：

• 问题 (1.0~)
• 项目 (1.0~)
• 用户 (1.1~)
• 时间记录 (1.1~)

工具

问题

• 搜索问题
  • 按项目、状态、指派者等过滤
  • 关键字搜索
  • 自定义字段支持
• 创建/更新问题
  • 设置跟踪器、状态、优先级
  • 配置自定义字段
  • 添加评论
• 删除问题

项目

• 搜索项目
  • 按活动/存档/关闭状态过滤
  • 关键字搜索
• 获取项目详情
  • 包含跟踪器、类别信息
• 创建/更新项目
  • 配置模块和跟踪器
  • 设置成员继承
• 归档/取消归档项目
• 删除项目

时间记录

• 搜索时间记录
  • 按项目、用户、日期范围过滤
• 获取时间记录详情
• 创建/更新时间记录
  • 记录到项目或问题
  • 指定活动
  • 自定义字段支持
• 删除时间记录

与 Claude 一起使用

要将此服务器与 Claude 一起使用，请按如下方式配置：

{
  "mcp-server-redmine": {
    "command": "npx",
    "args": [
      "-y",
      "--prefix",
      "/path/to/mcp-server-redmine",
      "mcp-server-redmine"
    ],
    "env": {
      "REDMINE_HOST": "https://your-redmine.example.com",
      "REDMINE_API_KEY": "your-api-key-here"
    }
  }
}

配置选项

• command: 执行 npm 包的命令
• args:
  • -y: 自动响应提示“是”
  • --prefix: 指定安装目录
  • 最后一个参数指定包名
• env: 环境变量
  • REDMINE_HOST: Redmine 服务器 URL
  • REDMINE_API_KEY: 您的 Redmine API 密钥

设置

获取 API 密钥

1. 在 Redmine 管理设置中启用 REST API
2. 从用户设置页面获取 API 密钥

环境变量

设置以下环境变量：

• REDMINE_API_KEY: 从 Redmine 用户设置中获得的 API 密钥
• REDMINE_HOST: Redmine 服务器 URL（例如：https://redmine.example.com）

测试

单元测试

# Run tests
npm test

为了数据安全，测试仅包括 GET 操作。

Inspector 测试

使用 MCP Inspector 来验证功能：

# Build
npm run build

# Set execute permission (important)
chmod +x dist/index.js

# Launch inspector
npx @modelcontextprotocol/inspector dist/index.js

权限

某些功能需要管理员权限：

与用户相关的操作

• list_users: 需要管理员权限
• create_user: 需要管理员权限
• update_user: 需要管理员权限
• delete_user: 需要管理员权限

可用信息根据用户权限级别而变化。详情请参阅 Redmine API 文档。

开发

要求

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

库

• @modelcontextprotocol/sdk: MCP SDK
• zod: 模式验证
• typescript: 类型系统

目录结构

.
├── src/
│   ├── tools/            # Tool definitions
│   │   ├── issues.ts
│   │   ├── projects.ts
│   │   ├── time_entries.ts
│   │   └── index.ts
│   ├── formatters/       # Formatters
│   │   ├── issues.ts
│   │   ├── projects.ts
│   │   ├── time_entries.ts
│   │   └── index.ts
│   ├── lib/             # Common libraries
│   │   ├── client.ts     # Redmine API client
│   │   ├── config.ts     # Configuration management
│   │   └── types.ts      # Type definitions
│   ├── handlers.ts       # Request handlers
│   └── index.ts         # Entry point
├── docs/
│   └── adr/             # Architecture Decision Records
├── package.json         # Project configuration
├── tsconfig.json        # TypeScript configuration
└── README.md           # Documentation

构建

# Install dependencies
npm install

# Build
npm run build

# Start development server
npm run dev

架构决策记录

主要设计决策记录在 docs/adr 中。添加或修改功能时，请参考这些文档。

许可证

MIT

相关项目

• Model Context Protocol
• MCP TypeScript SDK
• Redmine