Plane MCP Server

Ein Model Context Protocol (MCP)-Server ermöglicht LLMs die Interaktion mit Plane.so und ermöglicht ihnen die Verwaltung von Projekten und Problemen über die Plane-API. Mit diesem Server können LLMs wie Claude direkt mit Ihren Projektmanagement-Workflows interagieren und gleichzeitig die Benutzerkontrolle und Sicherheit gewährleisten.

Merkmale

• Listen Sie alle Projekte in Ihrem Plane-Arbeitsbereich auf

• Erhalten Sie detaillierte Informationen zu bestimmten Projekten

• Erstellen Sie neue Probleme mit anpassbaren Eigenschaften

• Auflisten und Filtern von Problemen aus Projekten

• Erhalten Sie detaillierte Informationen zu bestimmten Themen

• Aktualisieren Sie vorhandene Probleme mit neuen Informationen

Related MCP server: Plane MCP Server

Voraussetzungen

• Node.js 22.x oder höher

• Ein Plane.so API-Schlüssel

• Ein Plane.so-Arbeitsbereich

Installation

Option 1: Schmiedekunst verwenden

Der schnellste Weg zum Einstieg besteht darin, Smithery zu verwenden, um den Server direkt zu installieren:

# Install to Claude for Desktop
npx -y @smithery/cli install @kelvin6365/plane-mcp-server --client claude

Dieser Befehl richtet den Plane MCP-Server automatisch für die Verwendung mit Claude ein. Nach der Installation müssen Sie den Server mit Ihrem Plane-API-Schlüssel und Ihrem Arbeitsbereichs-Slug über die Claude-Einstellungen konfigurieren.

Gültige Client-Optionen sind: Claude, Cline, Windsurf, Roo-Cline, Witsy, Enconvo, Cursor

Beispiel für die Installation mit Cursor:

npx -y @smithery/cli install @kelvin6365/plane-mcp-server --client cursor

Option 2: Manuelle Einrichtung

Wenn Sie den Server lieber manuell einrichten möchten, führen Sie die folgenden Schritte aus:

1. Klonen Sie dieses Repository:

git clone https://github.com/kelvin6365/plane-mcp-server.git
cd plane-mcp-server

2. Installieren Sie Abhängigkeiten:

npm install

3. Erstellen Sie den Server:

npm run build

Verwendung mit Claude für Desktop

Hinweis: Wenn Sie oben Option 1 (Smithery) verwendet haben, können Sie diesen Abschnitt überspringen. Smithery konfiguriert den MCP-Server automatisch für Sie.

1. Öffnen Sie Ihre Claude for Desktop-Konfigurationsdatei:

   • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json

   • Windows: %APPDATA%\Claude\claude_desktop_config.json

2. Fügen Sie die Plane MCP-Serverkonfiguration hinzu:

{
  "mcpServers": {
    "plane": {
      "command": "node",
      "args": ["path/to/plane-mcp-server/build/index.js"],
      "env": {
        "PLANE_API_KEY": "your_plane_api_key_here",
        "PLANE_WORKSPACE_SLUG": "your_workspace_slug_here"
      }
    }
  }
}

3. Starten Sie Claude für Desktop neu

Verfügbare Tools

Hinweis: Toolnamen verwenden Bindestriche (z. B. list-projects ), keine Unterstriche. Der Server konvertiert Unterstriche aus Kompatibilitätsgründen automatisch in Bindestriche.

Liste-Projekte

Listet alle Projekte in Ihrem Plane-Arbeitsbereich auf.

Parameter: Keine

Beispiel:

{}

Projekt abrufen

Ruft detaillierte Informationen zu einem bestimmten Projekt ab.

Parameter:

• project_id : ID des abzurufenden Projekts

Beispiel:

{
  "project_id": "01abc123-4567-89de-0123-456789abcdef"
}

Problem erstellen

Erstellt ein neues Problem in einem angegebenen Projekt.

Parameter:

• project_id : ID des Projekts, in dem das Problem erstellt werden soll

• name : Titel der Ausgabe

• description_html : HTML-Beschreibung des Problems (erforderlich für die Plane-API)

• priority (optional): Priorität des Problems („dringend“, „hoch“, „mittel“, „niedrig“, „keine“)

• state_id (optional): ID des Staates für dieses Problem

• assignees (optional): Array von Benutzer-IDs, die diesem Problem zugewiesen werden sollen

Hinweis: Der Parameter assignees muss ein Array von Benutzer-ID-Zeichenfolgen sein. Häufige Fehler sind die Angabe eines Wörterbuchs/Objekts anstelle eines Arrays oder die versehentliche Verschachtelung der gesamten Problemdaten im Feld „assignees“. Der Server versucht, diese Fälle zu verarbeiten, es empfiehlt sich jedoch, das korrekte Format zu verwenden.

Beispiel:

{
  "project_id": "01abc123-4567-89de-0123-456789abcdef",
  "name": "Implement new feature",
  "description_html": "<p>We need to implement the new reporting feature</p>",
  "priority": "high",
  "assignees": ["user-id-1", "user-id-2"]
}

Listenprobleme

Listet Probleme aus einem angegebenen Projekt mit optionaler Filterung auf.

Parameter:

• project_id : ID des Projekts, aus dem Probleme abgerufen werden sollen

• state_id (optional): Filtern nach Status-ID

• priority (optional): Filtern nach Priorität

• assignee_id (optional): Filtern nach der Assignee-ID

• limit (optional): Maximale Anzahl der zurückzugebenden Probleme (Standard: 50)

Beispiel:

{
  "project_id": "01abc123-4567-89de-0123-456789abcdef",
  "priority": "high",
  "limit": 10
}

Problem abrufen

Ruft detaillierte Informationen zu einem bestimmten Problem ab.

Parameter:

• project_id : ID des Projekts, das das Problem enthält

• issue_id : ID des abzurufenden Problems

Beispiel:

{
  "project_id": "01abc123-4567-89de-0123-456789abcdef",
  "issue_id": "01def456-7890-12gh-3456-789ijklmnopq"
}

Update-Problem

Aktualisiert ein vorhandenes Problem in einem Projekt.

Parameter:

• project_id : ID des Projekts, das das Problem enthält

• issue_id : ID des zu aktualisierenden Problems

• name (optional): Aktualisierter Titel des Problems

• description_html (optional): HTML-Beschreibung des Problems (erforderlich für die Plane-API)

• priority (optional): Aktualisierte Priorität des Problems

• state_id (optional): Aktualisierte Status-ID des Problems

• assignees (optional): Aktualisiertes Array von Benutzer-IDs, die diesem Problem zugewiesen werden sollen

Hinweis: Der assignees -Parameter muss ein Array von Benutzer-ID-Zeichenfolgen sein und denselben Formatrichtlinien wie das Tool zum Erstellen von Problemen folgen.

Beispiel:

{
  "project_id": "01abc123-4567-89de-0123-456789abcdef",
  "issue_id": "01def456-7890-12gh-3456-789ijklmnopq",
  "priority": "urgent",
  "description_html": "<p>Updated description with <strong>more details</strong></p>"
}

Entwicklung

1. Installieren Sie Entwicklungsabhängigkeiten:

npm install --save-dev typescript @types/node

2. Starten Sie den Server im Entwicklungsmodus:

npm run dev

Testen

Sie können den Server mit dem MCP Inspector testen:

npx @modelcontextprotocol/inspector node dist/index.js

Beispiele

Hier sind einige Beispielinteraktionen, die Sie mit Claude ausprobieren können, nachdem Sie den Plane MCP-Server eingerichtet haben:

1. „Können Sie alle Projekte in meinem Plane-Arbeitsbereich auflisten?“

2. „Bitte erstellen Sie im Marketingprojekt ein neues Problem mit hoher Priorität mit dem Titel ‚Social-Media-Strategie aktualisieren‘.“

3. „Welche Probleme haben im Entwicklungsprojekt alle höchste Priorität?“

4. „Aktualisieren Sie Problem Nr. 123 im QA-Projekt, um seine Priorität auf dringend zu ändern.“

Claude wird die entsprechenden Tools verwenden, um mit Plane zu interagieren, und Sie vor dem Erstellen oder Ändern von Problemen um Ihre Zustimmung bitten.

Sicherheitsüberlegungen

• Der API-Schlüssel erfordert die entsprechenden Plane-Berechtigungen, um zu funktionieren

• Für alle Vorgänge, bei denen Daten geändert werden, ist eine ausdrückliche Zustimmung des Benutzers erforderlich.

• Umgebungsvariablen sollten ordnungsgemäß gesichert werden

• API-Schlüssel sollten niemals der Versionskontrolle übergeben werden

Beitragen

1. Forken Sie das Repository

2. Erstellen Sie Ihren Feature-Zweig ( git checkout -b feature/amazing-feature )

3. Übernehmen Sie Ihre Änderungen ( git commit -m 'Add some amazing feature' )

4. Pushen zum Zweig ( git push origin feature/amazing-feature )

5. Öffnen einer Pull-Anfrage

Lizenz

Dieses Projekt ist unter der MIT-Lizenz lizenziert – Einzelheiten finden Sie in der Datei LICENSE.

Unterstützung

Wenn Sie auf Probleme stoßen oder Fragen haben:

1. Überprüfen Sie den Abschnitt „GitHub-Probleme“

2. Konsultieren Sie die MCP-Dokumentation unter modelcontextprotocol.io

3. Öffnen Sie eine neue Ausgabe mit detaillierten Reproduktionsschritten

Sternengeschichte