​
Über MCP-Server

Das Model Context Protocol (MCP) ist ein offenes Protokoll, das standardisierte Verbindungen zwischen KI-Anwendungen und externen Diensten, etwa Ihrer Dokumentation, ermöglicht. Mintlify generiert aus Ihrer Dokumentation und Ihren OpenAPI-Spezifikationen einen MCP-Server und bereitet Ihre Inhalte für das breitere KI-Ökosystem auf, in dem sich jeder MCP-Client (wie Claude, Cursor, Goose und andere) mit Ihrer Dokumentation und Ihren APIs verbinden kann. Ihr MCP-Server stellt Tools bereit, mit denen KI-Anwendungen Ihre Dokumentation durchsuchen und mit Ihren APIs interagieren können.

​
Zugriff auf Ihren MCP-Server

MCP-Server können nur für öffentliche Dokumentation erstellt werden. Dokumentation, die hinter einer Endnutzer-Authentifizierung liegt, kann nicht für die Servererstellung genutzt werden.
Mintlify erstellt automatisch einen MCP-Server für Ihre Dokumentation und hostet ihn unter Ihrer Dokumentations-URL mit dem Pfad /mcp. Der MCP-Server von Mintlify ist beispielsweise unter https://mintlify.com/docs/mcp verfügbar. Sie können die URL Ihres MCP-Servers in Ihrem Dashboard anzeigen und kopieren. Der Pfad /mcp ist für gehostete MCP-Server reserviert und kann nicht für andere Navigationselemente verwendet werden.

​
Konfiguration Ihres MCP-Servers

Alle MCP-Server enthalten standardmäßig das Tool search, mit dem Nutzer Informationen aus Ihren Docs in anderen Tools abfragen können. Wenn Sie einen Pro- oder Enterprise-Plan haben, können Sie Endpunkte aus Ihrer OpenAPI-Spezifikation als MCP-Tools bereitstellen. Um Endpunkte als MCP-Tools verfügbar zu machen, verwenden Sie das Objekt mcp innerhalb der Erweiterung x-mint auf Datei- oder Endpunkt-Ebene. Der Mintlify-MCP-Server umfasst beispielsweise Tools zum Erstellen von Assistent-Chats, zum Abrufen von Statusupdates und zum Auslösen von Aktualisierungen. MCP-Server verfolgen einen Security-first-Ansatz, bei dem API-Endpunkte standardmäßig nicht freigegeben sind. Sie müssen Endpunkte explizit aktivieren, damit sie als MCP-Tools zur Verfügung stehen. Geben Sie nur Endpunkte frei, die für den öffentlichen Zugriff über KI-Tools sicher sind.
​
mcp
object
Die MCP-Konfiguration für den Endpunkt.

​
Konfiguration auf Dateiebene

Aktiviere MCP standardmäßig für alle Endpunkte in einer OpenAPI-Spezifikationsdatei und schließe einzelne Endpunkte gezielt aus: 
{
  "openapi": "3.1.0",
  "x-mint": {
    "mcp": {
      "enabled": true
    }
  },
  // ...
  "paths": {
    "/api/v1/users": {
      "get": {
        "x-mint": {
          "mcp": {
            "enabled": false // Deaktiviert MCP für diesen Endpunkt
          }
        },
        // ...
      }
    }
  }
}

​
Konfiguration auf Endpunktebene

Aktiviere MCP für bestimmte Endpunkte: 
{
  "paths": {
    "/api/v1/users": {
      "get": {
        "x-mint": {
          "mcp": {
            "enabled": true,
            "name": "get-users",
            "description": "Get a list of users"
          },
          // ...
        }
      }
    },
    "/api/v1/delete": {
      "delete": {
        // Kein `x-mint: mcp`, daher wird dieser Endpunkt nicht als MCP-Tool exponiert
        // ...
      }
    }
  }
}

​
Verwendung Ihres MCP-Servers

Ihre Nutzer müssen Ihren MCP-Server mit ihren bevorzugten KI-Tools verbinden.
  1. Stellen Sie die URL Ihres MCP-Servers öffentlich bereit.
  2. Nutzer kopieren die URL Ihres MCP-Servers und fügen sie in ihre Tools ein.
  3. Nutzer greifen über ihre Tools auf Ihre Dokumentation und API-Endpunkte zu.
So können Sie Ihren Nutzern helfen, sich mit Ihrem MCP-Server zu verbinden:
Fügen Sie Optionen im Kontextmenü hinzu, damit Ihre Nutzerinnen und Nutzer von jeder Seite Ihrer Dokumentation aus eine Verbindung zu Ihrem MCP-Server herstellen können.
OptionBezeichnerBeschreibung
MCP-Server-URL kopierenmcpKopiert Ihre MCP-Server-URL in die Zwischenablage des Nutzers.
Mit Cursor verbindencursorInstalliert Ihren MCP-Server in Cursor.
Mit VS Code verbindenvscodeInstalliert Ihren MCP-Server in VS Code.

​
Beispiel: Verbindung mit dem Mintlify MCP-Server

Verbinden Sie sich mit dem Mintlify MCP-Server, um mit der Mintlify-API zu interagieren und unsere Dokumentation zu durchsuchen. So erhalten Sie präzisere Antworten zur Nutzung von Mintlify in Ihrer lokalen Umgebung und sehen, wie Sie Ihren Nutzerinnen und Nutzern helfen können, sich mit Ihrem MCP-Server zu verbinden.
Wählen Sie oben auf dieser Seite das Kontextmenü und dann Mit Cursor verbinden oder Mit VS Code verbinden, um den Mintlify MCP-Server mit der IDE Ihrer Wahl zu verbinden.

​
Authentifizierung

Wenn Sie einen API-Endpunkt für MCP aktivieren, übernimmt der Server die in Ihren OpenAPI-Definitionen securitySchemes und securityRequirement festgelegten Authentifizierungsanforderungen. Etwaige Schlüssel werden ausschließlich vom Tool gehandhabt und weder von Mintlify gespeichert noch verarbeitet. Fordert ein Benutzer sein KI-Tool auf, einen geschützten Endpunkt aufzurufen, verlangt das Tool in diesem Moment die notwendigen Anmeldedaten vom Benutzer.

​
Überwachung Ihres MCP-Servers

Alle verfügbaren MCP-Tools finden Sie im Abschnitt Available tools auf der MCP-Server-Seite in Ihrem Dashboard.
MCP-Dashboard mit hervorgehobenem Abschnitt „Available tools“

​
Fehlerbehebung