Shortcut.com MCP-Server

Eine Implementierung eines Model Context Protocol (MCP)-Servers für den Zugriff auf und die Suche nach Tickets auf Shortcut.com.

Überblick

Dieses Projekt implementiert einen MCP-Server, der es Claude und anderen MCP-kompatiblen KI-Assistenten ermöglicht, mit dem Ticketverwaltungssystem von Shortcut.com zu interagieren. Dank dieser Integration können KI-Assistenten:

• Auflisten und Suchen von Storys (Tickets) in Shortcut

• Erhalten Sie detaillierte Informationen zu bestimmten Geschichten

• Neue Geschichten erstellen

• Vorhandene Storys aktualisieren

• Kommentare zu Storys hinzufügen

• Abrufen von Workflow-Status und Projekten

Related MCP server: Shortcut MCP Server

Voraussetzungen

• Python 3.10+

• Shortcut.com API-Token

Installation

1. Klonen Sie dieses Repository:

   git clone https://github.com/yourusername/mcp-server-shortcut.git
   cd mcp-server-shortcut

2. Erstellen Sie eine virtuelle Umgebung und installieren Sie Abhängigkeiten:

   # Using uv (recommended)
   curl -LsSf https://astral.sh/uv/install.sh | sh  # For Mac/Linux
   uv venv
   source .venv/bin/activate  # On Mac/Linux or .venv\Scripts\activate on Windows
   uv pip install -r requirements.txt
   
   # Using pip
   python -m venv venv
   source venv/bin/activate  # On Mac/Linux or venv\Scripts\activate on Windows
   pip install -r requirements.txt

3. Erstellen Sie im Stammverzeichnis des Projekts eine .env Datei mit Ihrem Shortcut-API-Token:

   SHORTCUT_API_TOKEN=your_token_here
   SERVER_PORT=5000
   SERVER_HOST=0.0.0.0
   DEBUG_MODE=True

Ausführen des Servers

Starten Sie den MCP-Server mit:

python -m src.server

Konfigurieren von Claude Desktop

So verwenden Sie diesen MCP-Server mit Claude Desktop:

1. Bearbeiten Sie die Claude Desktop-Konfigurationsdatei:

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

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

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

   {
     "mcpServers": {
       "shortcut": {
         "command": "python",
         "args": ["-m", "src.server"],
         "env": {
           "SHORTCUT_API_TOKEN": "your_token_here"
         }
       }
     }
   }

3. Starten Sie Claude Desktop neu.

Verfügbare MCP-Funktionen

Ressourcen

• shortcut://stories - Zugriff auf eine Liste von Geschichten

• shortcut://story/{story_id} – Zugriff auf eine bestimmte Story

Werkzeuge

• list_stories – Storys auflisten mit optionaler Filterung

• search_stories - Suche nach Geschichten mit Textabfragen

• get_story_details – Erhalten Sie detaillierte Informationen zu einer bestimmten Story

• create_story - Erstelle eine neue Story

• update_story - Eine vorhandene Story aktualisieren

• add_comment - Einen Kommentar zu einer Story hinzufügen

• list_workflow_states – Alle Workflow-Status auflisten

• list_projects - Alle Projekte auflisten

Eingabeaufforderungen

• create_bug_report - Erstellen Sie eine Vorlage für Fehlerberichte

• create_feature_request - Erstellen Sie eine Vorlage für Funktionsanfragen

Projektstruktur

• src/ - Quellcode-Verzeichnis

  • server.py - Hauptimplementierung des MCP-Servers

  • config.py - Konfigurationsverwaltung

  • shortcut_client.py – Client für die Shortcut-API

  • utils.py – Dienstprogrammfunktionen und Datenmodelle

• requirements.txt – Projektabhängigkeiten

• .env – Umgebungsvariablen (werden in Git nicht verfolgt)

Entwicklung

Neue Funktionen hinzufügen

So fügen Sie dem MCP-Server eine neue Funktion hinzu:

1. Fügen Sie neue API-Methoden zu shortcut_client.py hinzu

2. Definieren Sie bei Bedarf Pydantic-Modelle in utils.py

3. Implementieren Sie die MCP-Funktionalität mithilfe von Dekoratoren in server.py :

   • Verwenden Sie @mcp.resource() für schreibgeschützte Ressourcen

   • Verwenden Sie @mcp.tool() für Aktionen, die Daten ändern können

   • Verwenden Sie @mcp.prompt() zum Generieren von Vorlagen oder strukturiertem Text

Beitragen

Beiträge sind willkommen! Senden Sie gerne einen Pull Request.

Lizenz

MIT-Lizenz