OR

onozaty/redmine-mcp-server

开发工具

本页由 AI 翻译,技术细节请以原文为准。 查看原文

30 stars 16 forks 质量 85 趋势 31MIT

Redmine 的模型上下文协议(MCP)服务器,提供对 Redmine REST API 的全面访问。

概览

Redmine 的模型上下文协议(MCP)服务器,提供对 Redmine REST API 的全面访问。 该项目是一个全面覆盖 Redmine REST API 的 MCP 服务器。它允许你从 MCP 客户端(如 Claude Desktop)上运行 Redmine。 以下是示例视频,展示了如何使用Redmine MCP服务器配合Claude Desktop: https://github.com/user-attachments/assets/075fb079-104c-404d-91f5-755b3882853b 该演示还将Playwright MCP用于浏览器自动化,配合Redmine MCP服务器。 https://github.com/user-attachments/assets/8f551082-6982-4513-8fe7-b0f111be982d - 📋 : 支持Redmine REST API中的所有功能 - 🔒 : 支持安全数据参考模式 - 🔧 : 使用正则表达式模式控制可用工具 - 🏷️ : 声明仅读提示,以便客户端区分读操作和写操作 1. 用管理员权限登录Redmine 2.进入“管理”→“设置”→“API”标签 3.

概述(AI 翻译)

Redmine 的模型上下文协议(MCP)服务器,提供对 Redmine REST API 的全面访问。

概述

该项目是一个全面覆盖 Redmine REST API 的 MCP 服务器。它允许你从 MCP 客户端(如 Claude Desktop)上运行 Redmine。

演示

以下是示例视频,展示了如何使用Redmine MCP服务器配合Claude Desktop:

制造问题

https://github.com/user-attachments/assets/075fb079-104c-404d-91f5-755b3882853b

本演示还使用Playwright MCP进行浏览器自动化,配合Redmine MCP服务器。

获取问题信息

https://github.com/user-attachments/assets/8f551082-6982-4513-8fe7-b0f111be982d

特色

  • 📋 全面的API覆盖:支持Redmine REST API中所有可用的功能
  • 🔒 只读模式:支持安全数据参考模式
  • 🔧 工具过滤:使用正则表达式模式控制可用的工具
  • 🏷️ 工具注释:声明readOnlyHint,以便客户端区分读操作和写操作

先修条件

获取Redmine API密钥

  1. 使用管理员权限登录Redmine

本页由 AI 翻译,技术细节请以原文为准。

README

以下为原文 README 节选,完整内容请查看原文。

Redmine MCP Server

Model Context Protocol (MCP) server for Redmine that provides comprehensive access to the Redmine REST API.

Overview

This project is an MCP server that comprehensively covers Redmine’s REST API. It allows you to operate Redmine from MCP clients (such as Claude Desktop).

Demonstration

Here are example videos showing how to use the Redmine MCP server with Claude Desktop:

Creating an Issue

https://github.com/user-attachments/assets/075fb079-104c-404d-91f5-755b3882853b

This demonstration also uses the Playwright MCP for browser automation alongside the Redmine MCP server.

Getting Issue Information

https://github.com/user-attachments/assets/8f551082-6982-4513-8fe7-b0f111be982d

Features

  • 📋 Comprehensive API Coverage: Supports all functions available in Redmine’s REST API
  • 🔒 Read-Only Mode: Supports safe data reference mode
  • 🔧 Tool Filtering: Control which tools are available using regex patterns
  • 🏷️ Tool Annotations: Declares readOnlyHint so clients can tell read operations from write ones

Prerequisites

Getting Redmine API Key

  1. Log in to Redmine with administrator privileges
  2. Go to “Administration” → “Settings” → “API” tab
  3. Check “Enable REST web service”
  4. Generate “API access key” in personal settings

For details, refer to Redmine REST API documentation.

Configuration

Environment Variables

The following environment variables are required (specified in MCP client configuration files):

  • REDMINE_URL (Required): Base URL of the Redmine instance
    • Example: https://redmine.example.com
  • REDMINE_API_KEY (Required): API key generated in Redmine
    • Set the API key obtained in prerequisites
  • REDMINE_MCP_READ_ONLY (Optional): Enable read-only mode
    • true: Read-only mode (disables data modification operations)
    • false or unset: Allow all operations (default)
  • REDMINE_MCP_TOOLS_ALLOW_PATTERN (Optional): Regex pattern to allow only matching tools
    • Example: ^get (enable only tools starting with “get”)
    • If unset, all tools are allowed (subject to other settings)
  • REDMINE_MCP_TOOLS_DENY_PATTERN (Optional): Regex pattern to disable matching tools
    • Example: ^delete (disable all tools starting with “delete”)
    • If unset, no tools are denied (subject to other settings)
    • Deny pattern takes priority over allow pattern

MCP Client Configuration

Add the following as MCP configuration for your AI agent:

{
  "mcpServers": {
    "redmine": {
      "command": "npx",
      "args": ["-y", "@onozaty/redmine-mcp-server"],
      "env": {
        "REDMINE_URL": "https://your-redmine.example.com",
        "REDMINE_API_KEY": "your-api-key-here",
        "REDMINE_MCP_READ_ONLY": "true"
      }
在 GitHub 查看完整 README

安装

npx -y @onozaty/redmine-mcp-server
新手?先看 mcpskill.org 教程 →

配置

{ "mcpServers": { "redmine": { "command": "npx", "args": ["-y", "@onozaty/redmine-mcp-server"], "env": { "REDMINE_URL": "https://your-redmine.example.com", "REDMINE_API_KEY": "your-api-key-here", "REDMINE_MCP_READ_ONLY": "true" } } } }