Zum Hauptinhalt springen

MCP-Server-Integration

docStatic verfügt über einen integrierten Model Context Protocol (MCP)-Server, der es KI-Assistenten ermöglicht, auf Ihre Dokumentation zuzugreifen und diese zu verstehen. Dies bietet intelligente Unterstützung bei der Bearbeitung, Suche und Analyse von Inhalten.

Überblick​

Der MCP-Server verbindet KI-Assistenten über den TinaCMS-GraphQL-Endpunkt direkt mit Ihrer docStatic-Dokumentation und ermöglicht ihnen so:

  • die Suche nach Dokumentationsinhalten mithilfe von Abfragen in natürlicher Sprache
  • das Abrufen bestimmter Dokumente anhand von Pfaden oder Kriterien
  • die Analyse von Nutzungsmustern von MDX-Komponenten
  • die Dokumentstruktur und Metadaten zu verstehen
  • kontextbezogene Unterstützung auf Basis Ihrer tatsächlichen Inhalte bereitzustellen

Voraussetzungen​

  • Node.js 22.0 oder höher, dieselbe Version, die auch docStatic selbst benötigt
  • Ein laufender docStatic-Entwicklungsserver (npm run dev)
  • TinaCMS-GraphQL-Endpunkt verfügbar unter [localhost](http://localhost:4001/graphql)

Einrichtung​

1. MCP-Server-Abhängigkeiten installieren​

Aus dem docStatic-Hauptverzeichnis:

npm run mcp:install

Dadurch werden die erforderlichen MCP-Server-Abhängigkeiten im Unterverzeichnis mcp-server installiert.

2. MCP-Server erstellen​

npm run mcp:build

Dadurch wird der TypeScript-Code des MCP-Servers zu JavaScript kompiliert.

3. docStatic-Entwicklungsserver starten​

Für den MCP-Server muss Ihre docStatic-Website laufen:

npm run dev

Dadurch werden gestartet:

  • Docusaurus unter [http://localhost:3000](http://localhost:3000`)
  • TinaCMS-Admin unter [localhost](http://localhost:3000/admin)
  • GraphQL-Endpunkt unter [localhost](http://localhost:4001/graphql)

4. MCP-Server ausführen​

In einem separaten Terminal:

npm run mcp:start

Für die Entwicklung mit automatischem Neustart bei Änderungen:

npm run mcp:dev

Verfügbare Tools​

Der MCP-Server stellt mehrere Tools bereit, die KI-Assistenten nutzen können:

Dokumentensuche​

  • `search_documents`: Dokumente über die Stichwortsuche finden
  • `get_document`: Ein bestimmtes Dokument über den Pfad abrufen
  • `list_all_documents`: Metadaten für alle Dokumente abrufen

Inhaltsanalyse​

  • `get_documents_by_tag`: Dokumente nach Taxonomie-Tags filtern
  • `analyze_mdx_components`: In Dokumenten verwendete MDX-Komponenten identifizieren
  • `check_server_status`: GraphQL-Verbindung überprüfen

Konfiguration mit Claude Desktop​

Um den MCP-Server mit Claude Desktop zu verwenden, fügen Sie diese Konfiguration zu Ihren Claude Desktop-MCP-Einstellungen hinzu:

{
  "mcpServers": {
    "docstatic": {
      "command": "node",
      "args": ["/absolute/path/to/docstatic/mcp-server/dist/server.js"],
      "cwd": "/absolute/path/to/docstatic"
    }
  }
}
Pfadvoraussetzungen

Ersetzen Sie /absolute/path/to/docstatic durch den vollständigen Pfad zu Ihrem docStatic-Projektverzeichnis. Sowohl der Pfad args als auch der Pfad cwd müssen absolute Pfade sein.

Entwicklungsbefehle​

BefehlBeschreibungnpm run mcp:installMCP-Server-Abhängigkeiten installierennpm run mcp:buildTypeScript zu JavaScript kompilierennpm run mcp:startDen kompilierten MCP-Server startennpm run mcp:devIm Entwicklungsmodus kompilieren und starten

Fehlerbehebung​

Häufige Probleme​

„GraphQL-Server läuft nicht“

  • Stelle sicher, dass npm run dev im Hauptverzeichnis läuft
  • Überprüfe, ob [localhost](http://localhost:4001/graphql) erreichbar ist
  • Überprüfe, ob TinaCMS vollständig gestartet wurde

„Verbindung abgelehnt“

  • Vergewissern Sie sich, dass der Entwicklungsserver läuft
  • Prüfen Sie, ob Port 4001 verfügbar ist
  • Stellen Sie sicher, dass die Firewall-Einstellungen die Verbindung nicht blockieren

„Dokument nicht gefunden“

  • Verwenden Sie relative Pfade wie installation.mdx, nicht /docs/installation.mdx
  • Stellen Sie sicher, dass das Dokument im Verzeichnis docs/ vorhanden ist
  • Überprüfen Sie, ob die Datei über korrekten MDX-Frontmatter verfügt

Verbindung testen​

Testen Sie den GraphQL-Endpunkt direkt:

curl -X POST http://localhost:4001/graphql \
  -H "Content-Type: application/json" \
  -d '{"query":"{ __typename }"}'

Erwartete Antwort:

{"data":{"__typename":"Query"}}

MCP-Serverprotokolle überprüfen​

Der MCP-Server protokolliert in stderr. Wenn Sie Claude Desktop verwenden, überprüfen Sie die Claude-Desktop-Protokolle auf Fehlermeldungen vom MCP-Server.

Vorteile für den Dokumentations-Workflow​

Dank der MCP-Integration können KI-Assistenten:

  1. Ihre Inhaltsstruktur verstehen - Auf die vollständige Taxonomie und Dokumenthierarchie zugreifen
  2. Präzise Vorschläge unterbreiten – Empfehlungen auf der Grundlage Ihrer tatsächlichen Dokumentationsmuster
  3. Zur Konsistenz beitragen – Erkennen, wo ähnliche Inhalte oder Komponenten verwendet werden sollten
  4. Die Bearbeitung beschleunigen – Schnell verwandte Inhalte finden und Verbesserungsvorschläge unterbreiten
  5. Muster analysieren – Häufig verwendete Komponenten und Inhaltslücken identifizieren

Architektur​

docStatic Project
├── docs/               # Your MDX documentation files
├── mcp-server/         # MCP server implementation
│   ├── src/server.ts   # Main server logic
│   ├── package.json    # MCP-specific dependencies
│   └── dist/           # Compiled JavaScript
└── tina/               # TinaCMS configuration
    └── config.jsx      # GraphQL schema definition

Der MCP-Server fungiert als Brücke zwischen KI-Assistenten und Ihren docStatic-Inhalten und bietet über die bestehende TinaCMS-GraphQL-API strukturierten Zugriff auf die Dokumentation.

Nächste Schritte​

Nach der Einrichtung des MCP-Servers:

  1. Testen Sie die Integration mit Ihrem KI-Assistenten
  2. Entdecken Sie die Suchfunktionen für die Dokumentation
  3. Nutzen Sie Tools zur Inhaltsanalyse, um Ihre Dokumentationsmuster zu verstehen
  4. Nutzen Sie KI-Unterstützung für Workflows zur Erstellung und Bearbeitung von Inhalten

Ausführliche Informationen zur Implementierung des MCP-Servers finden Sie auf der Seite Details zur MCP-Server-Implementierung.