Zum Hauptinhalt springen

Installation

Voraussetzungen​

  • Node.js >=22.12.0 (in engines angegeben).

Installation​

npm install @powerduck/openapi-mcp-server

Yarn:

yarn add @powerduck/openapi-mcp-server

pnpm:

pnpm add @powerduck/openapi-mcp-server

CLI​

Das Paket registriert das Programm openapi-mcp.

# global install
npm install -g @powerduck/openapi-mcp-server

# or run without installing
npx --package @powerduck/openapi-mcp-server openapi-mcp --help

Die CLI bietet einen einzigen Befehl, serve (siehe Schnellstart).

ESM / CommonJS​

Beide Build-Formate enthalten Typdeklarationen. Zusätzliche @types/*-Pakete sind nicht nötig:

// ESM
import { buildMcpServer, startStdioServer } from "@powerduck/openapi-mcp-server";

// CommonJS
const { buildMcpServer, startStdioServer } = require("@powerduck/openapi-mcp-server");

Unterpfad-Export​

ImportInhalt
@powerduck/openapi-mcp-serverKernbibliothek: Laden von Spezifikationen, Erzeugen von Tools, Prompts und Ressourcen, Ausführen von Anfragen, Aufbau des MCP-Servers sowie stdio- und HTTP-Transporte.
@powerduck/openapi-mcp-server/serverHTTP-Administrationsserver und Authentifizierungs-Middleware (startAdminServer, createAuthMiddleware).

Laufzeitabhängigkeiten​

Diese Abhängigkeiten werden automatisch mit dem Paket installiert:

  • @modelcontextprotocol/sdk — Implementierung des MCP-Protokolls.
  • @powerduck/openapi-parser — OpenAPI-Validierung, Referenzauflösung und Aktualisierung.
  • express und cors — HTTP-Administrationsserver und CORS.
  • axios — HTTP-Client zum Aufruf des Zielservers bei der Werkzeugausführung.
  • commander — CLI-Framework.
  • js-yaml — YAML-Parsing.
  • multer — Verarbeitung hochgeladener Spezifikationen.
  • terser — Minifizierung der eingebetteten Weboberflächen-Dateien.

Überprüfung​

npx --package @powerduck/openapi-mcp-server openapi-mcp --help

Nächste Schritte​