Redmine MCP Server

Dies ist eine Model Context Protocol (MCP)-Serverimplementierung für Redmine. Sie integriert sich in die REST-API von Redmine, um Ticket- und Projektinformationen für LLMs bereitzustellen.

Merkmale

Unterstützt stabile Ressourcen von der Redmine REST API:

Probleme (1.0~)
Projekte (1.0~)
Benutzer (1,1~)
Zeiteinträge (1.1~)

Werkzeuge

Probleme

Suchprobleme
- Filtern Sie nach Projekt, Status, Beauftragtem usw.
- Stichwortsuche
- Unterstützung für benutzerdefinierte Felder
Probleme erstellen/aktualisieren
- Tracker, Status, Priorität festlegen
- Konfigurieren benutzerdefinierter Felder
- Kommentare hinzufügen
Probleme löschen

Projekte

Projekte suchen
- Filtern nach aktivem/archiviertem/geschlossenem Status
- Stichwortsuche
Projektdetails abrufen
- Tracker und Kategorieninformationen einschließen
Projekte erstellen/aktualisieren
- Konfigurieren Sie Module und Tracker
- Festlegen der Mitgliedervererbung
Projekte archivieren/dearchivieren
Projekte löschen

Zeiteinträge

Zeiteinträge suchen
- Filtern nach Projekt, Benutzer, Datumsbereich
Zeiteintragsdetails abrufen
Zeiteinträge erstellen/aktualisieren
- Aufzeichnung gegen Projekt oder Problem
- Aktivität angeben
- Unterstützung für benutzerdefinierte Felder
Zeiteinträge löschen

Verwendung mit Claude

Um diesen Server mit Claude zu verwenden, konfigurieren Sie ihn wie folgt:

{
  "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"
    }
  }
}

Konfigurationsoptionen

command : Befehl zum Ausführen des npm-Pakets
args :
- -y : Automatische Antwort mit „Ja“ auf Eingabeaufforderungen
- --prefix : Installationsverzeichnis angeben
- Das letzte Argument gibt den Paketnamen an
env : Umgebungsvariablen
- REDMINE_HOST : Redmine-Server-URL
- REDMINE_API_KEY : Ihr Redmine-API-Schlüssel

Aufstellen

Einen API-Schlüssel erhalten

Aktivieren Sie die REST-API in den Redmine-Administratoreinstellungen
Holen Sie sich den API-Schlüssel von der Benutzereinstellungsseite

Umgebungsvariablen

Legen Sie die folgenden Umgebungsvariablen fest:

REDMINE_API_KEY : API-Schlüssel, der aus den Redmine-Benutzereinstellungen abgerufen wurde
REDMINE_HOST : Redmine-Server-URL (z. B. https://redmine.example.com )

Testen

Unit-Tests

# Run tests
npm test

Aus Gründen der Datensicherheit werden in die Tests nur GET-Operationen einbezogen.

Inspektorprüfung

Verwenden Sie MCP Inspector , um die Funktionalität zu überprüfen:

# Build
npm run build

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

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

Berechtigungen

Für einige Funktionen sind Administratorrechte erforderlich:

Benutzerbezogene Vorgänge

list_users : Administrator erforderlich
create_user : Administrator erforderlich
update_user : Administrator erforderlich
delete_user : Administrator erforderlich

Die verfügbaren Informationen variieren je nach Benutzerberechtigungsstufe. Weitere Informationen finden Sie in der Redmine-API-Dokumentation .

Entwicklung

Anforderungen

Node.js 18 oder höher
npm 9 oder höher

Bibliotheken

@modelcontextprotocol/sdk : MCP SDK
zod : Schemavalidierung
typescript : Typsystem

Verzeichnisstruktur

.
├── 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

Gebäude

# Install dependencies
npm install

# Build
npm run build

# Start development server
npm run dev

Architekturentscheidungsdatensätze

Wichtige Designentscheidungen sind in docs/adr dokumentiert. Beachten Sie diese Dokumente, wenn Sie Funktionen hinzufügen oder ändern.

Lizenz

MIT

Redmine MCP Server