OpenAPI MCP Server

Was macht der „OpenAPI“ MCP Server?

Der OpenAPI MCP Server ist ein Model Context Protocol (MCP) Server, der entwickelt wurde, um KI-Assistenten (wie Claude und Cursor) die Möglichkeit zu geben, OpenAPI-Spezifikationen über oapis.org zu durchsuchen und zu erkunden. Als Brücke ermöglicht er KI-Modellen ein umfassendes Verständnis komplexer APIs in einfacher Sprache. Der Server folgt einem dreistufigen Prozess: Erkennung der benötigten OpenAPI-Spezifikation, Zusammenfassung in verständlichen Begriffen und detaillierte Darstellung der Endpunkte und ihrer Nutzung. Während er API-Endpunkte nicht direkt ausführt (aufgrund von Authentifizierungsbeschränkungen), überzeugt er bei der Bereitstellung von API-Überblicken, unterstützt die Code-Generierung und fördert Entwicklungsworkflows, bei denen das Verständnis und die Dokumentation der API-Struktur entscheidend sind.

Liste der Prompts

• Overview Prompt: Fordert eine Zusammenfassung und ein Verständnis einer OpenAPI-Spezifikation an.
• Operation Details Prompt: Ruft detaillierte Beschreibungen spezifischer API-Operationen ab.
• Endpoint Identification Prompt: Bestimmt anhand einer Anfrage, welche Endpunkte relevant sind.

Liste der Ressourcen

• OpenAPI-Spezifikationsübersicht: Bietet Zusammenfassungen kompletter API-Spezifikationen.
• API-Operationsdetails: Liefert Kontextinformationen zu bestimmten Endpunkten und deren Parametern.
• Format-Flexibilität: Unterstützt API-Spezifikationen sowohl im JSON- als auch YAML-Format.
• Kompatibilitätsressource: Getestete Ressourcen mit Claude Desktop und Cursor für nahtlose Kontextintegration.

Liste der Tools

• In v2 werden keine ausführbaren Tools bereitgestellt; der Server konzentriert sich auf die Erkundung und Kontextbereitstellung von APIs, ermöglicht aber keine direkte Endpunktausführung als Tool.

Anwendungsfälle dieses MCP Servers

• API-Dokumentationsgenerierung: Automatische Erstellung von menschenlesbarer Dokumentation aus komplexen OpenAPI-Spezifikationen, um APIs für Entwickler verständlicher zu machen.
• Unterstützung bei der API-Code-Generierung: Unterstützung von Entwicklern bei der Generierung von Client-Code durch klare Endpunktbeschreibungen und Nutzungsdetails.
• API-Entdeckung und -Erkundung: Schnelle Identifikation und Zusammenfassung verfügbarer Endpunkte, um Teams oder KI-Modellen die API-Fähigkeiten aufzuzeigen.
• Kontextbereitstellung für KI-Agenten: Bereitstellung relevanter API-Kontexte für LLMs oder Agenten, um deren Fähigkeit zu verbessern, Fragen zu beantworten oder Code mit externen APIs zu schreiben.
• Onboarding und Training: Unterstützung neuer Teammitglieder oder KI-Agenten beim Kennenlernen unbekannter APIs durch vereinfachte Zusammenfassungen und Operationsaufteilungen.

Einrichtung

Windsurf

1. Stellen Sie sicher, dass Node.js auf Ihrem System installiert ist.
2. Öffnen Sie Ihre Windsurf-Konfigurationsdatei.
3. Fügen Sie den OpenAPI MCP Server im Bereich mcpServers mit dem bereitgestellten JSON-Snippet hinzu.
4. Speichern Sie die Konfiguration und starten Sie Windsurf neu.
5. Überprüfen Sie die Verbindung zum MCP Server.

Beispielkonfiguration:

{
  "mcpServers": {
    "openapi-mcp": {
      "command": "npx",
      "args": ["@janwilmake/openapi-mcp-server@latest"],
      "env": {
        "OAS_API_KEY": "${OAS_API_KEY}"
      }
    }
  }
}

Hinweis: Sichern Sie Ihre API-Schlüssel durch die Nutzung von Umgebungsvariablen wie oben gezeigt.

Claude

1. Installieren Sie Node.js.
2. Öffnen Sie die MCP-Integrations-Einstellungen von Claude.
3. Fügen Sie den OpenAPI MCP Server mit folgender Konfiguration hinzu.
4. Speichern Sie die Einstellungen und starten Sie Claude neu.
5. Stellen Sie sicher, dass der Server als MCP-Ressource verfügbar ist.

Beispielkonfiguration:

{
  "mcpServers": {
    "openapi-mcp": {
      "command": "npx",
      "args": ["@janwilmake/openapi-mcp-server@latest"],
      "env": {
        "OAS_API_KEY": "${OAS_API_KEY}"
      }
    }
  }
}

Cursor

1. Stellen Sie sicher, dass Node.js installiert ist.
2. Lokalisieren Sie die Konfigurationsdatei von Cursor.
3. Fügen Sie den OpenAPI MCP Server unter mcpServers ein.
4. Speichern und starten Sie Cursor neu.
5. Testen Sie mit einer Beispiel-OpenAPI-Anfrage.

Beispielkonfiguration:

{
  "mcpServers": {
    "openapi-mcp": {
      "command": "npx",
      "args": ["@janwilmake/openapi-mcp-server@latest"],
      "env": {
        "OAS_API_KEY": "${OAS_API_KEY}"
      }
    }
  }
}

Cline

1. Installieren Sie Node.js, falls noch nicht geschehen.
2. Bearbeiten Sie die Cline-Konfigurationsdatei, um den OpenAPI MCP hinzuzufügen.
3. Fügen Sie folgenden JSON-Block ein.
4. Speichern Sie die Änderungen und starten Sie Cline neu.
5. Überprüfen Sie, ob der MCP Server aktiv ist.

Beispielkonfiguration:

{
  "mcpServers": {
    "openapi-mcp": {
      "command": "npx",
      "args": ["@janwilmake/openapi-mcp-server@latest"],
      "env": {
        "OAS_API_KEY": "${OAS_API_KEY}"
      }
    }
  }
}

API-Schlüssel sichern:
Speichern Sie sensible Schlüssel in Umgebungsvariablen und referenzieren Sie diese in Ihrer Konfiguration wie im Feld env gezeigt.

Nutzung dieses MCP in Flows

MCP in FlowHunt verwenden

Um MCP-Server in Ihren FlowHunt-Workflow zu integrieren, fügen Sie zunächst die MCP-Komponente zu Ihrem Flow hinzu und verbinden Sie sie mit Ihrem KI-Agenten:

Klicken Sie auf die MCP-Komponente, um das Konfigurationspanel zu öffnen. Im Bereich System-MCP-Konfiguration fügen Sie Ihre MCP-Serverdaten in folgendem JSON-Format ein:

{
  "openapi-mcp": {
    "transport": "streamable_http",
    "url": "https://yourmcpserver.example/pathtothemcp/url"
  }
}

Nach der Konfiguration kann der KI-Agent diesen MCP als Tool verwenden und auf alle Funktionen und Fähigkeiten zugreifen. Denken Sie daran, “openapi-mcp” durch den tatsächlichen Namen Ihres MCP-Servers zu ersetzen und die URL entsprechend Ihrer MCP-Server-Adresse anzupassen.

Übersicht

Unsere Meinung

Der OpenAPI MCP Server ist ein fokussierter und nützlicher MCP, der im Bereich Kontext und Erkundungs-Tools für OpenAPI-Spezifikationen überzeugt. Das Fehlen der Endpunktausführung ist für einige fortgeschrittene Anwendungsfälle eine Einschränkung, und Sampling-/Roots-Support ist nicht dokumentiert. Dennoch machen die klaren Einrichtungsanweisungen, die solide Codebasis und die aktive Nutzung in der Community ihn zu einer starken Lösung für Entwickler, die API-Kontext und Unterstützung bei der Code-Generierung benötigen.

MCP Score