Aller au contenu principal

Installation

Prérequis​

  • Node.js >=22.12.0 (déclaré dans engines).

Installation​

npm install @powerduck/openapi-mcp-server

Yarn:

yarn add @powerduck/openapi-mcp-server

pnpm:

pnpm add @powerduck/openapi-mcp-server

CLI​

Le paquet enregistre l’exécutable openapi-mcp.

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

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

La CLI comporte une seule commande, serve (voir Démarrage rapide).

ESM / CommonJS​

Les deux formats sont fournis avec les déclarations de types. Aucun paquet @types/* supplémentaire n’est nécessaire :

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

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

Export de sous-chemin​

ImportContenu
@powerduck/openapi-mcp-serverBibliothèque principale : chargement des spécifications, génération des outils, prompts et ressources, exécution des requêtes, construction du serveur MCP et transports stdio et HTTP.
@powerduck/openapi-mcp-server/serverServeur HTTP d’administration et middleware d’authentification (startAdminServer, createAuthMiddleware).

Dépendances d’exécution​

Ces dépendances sont installées automatiquement avec le paquet :

  • @modelcontextprotocol/sdk — implémentation du protocole MCP.
  • @powerduck/openapi-parser — validation, déréférencement et mise à niveau d’OpenAPI.
  • express et cors — serveur HTTP d’administration et CORS.
  • axios — client HTTP vers le serveur cible pour exécuter les outils.
  • commander — framework de la CLI.
  • js-yaml — analyse du YAML.
  • multer — gestion du téléversement des spécifications.
  • terser — minification des ressources de l’interface web intégrée.

Vérification​

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

Étapes suivantes​