@powerduck/openapi-mcp-server — Introduzione
@powerduck/openapi-mcp-server converte un documento OpenAPI in un servizio MCP (Model Context Protocol) in esecuzione. Genera strumenti dalle operazioni, prompt dai metadati e dalle operazioni dell’API e risorse dal catalogo. Li espone tramite MCP e include un’interfaccia web di amministrazione.
- Nome del pacchetto:
@powerduck/openapi-mcp-server - Versione:
- Licenza: MIT
- Versione di Node:
>=22.12.0 - Eseguibile CLI:
openapi-mcp - Formato dei moduli: Build ESM e CommonJS con dichiarazioni dei tipi incluse.
Si basa su @powerduck/openapi-parser per la convalida e la risoluzione dei riferimenti e su @modelcontextprotocol/sdk per il protocollo.
Contenuti generati
- Tools — Uno strumento MCP per ogni operazione OpenAPI, con serializzazione completa dei parametri (stili path/query/header/cookie e regole explode), codifica del corpo (JSON, form-urlencoded, multipart, testo e dati binari) e annotazioni MCP (
readOnlyHint,destructiveHint,idempotentHint). - Prompts — Prompt globali (
spec_overview,integration_guardrails) e specifici per operazione (explain_*,plan_*,sample_*). - Resources — Risorse di catalogo fisse, come
openapi://spec/summary,openapi://catalog/toolseopenapi://spec/document.
Trasporti
- stdio —
startStdioServer()fornisce un documento a un client MCP locale, come Claude Desktop o un’integrazione per editor. - HTTP —
attachMcpRoutes(app, options)monta Streamable HTTP su/mcpe, facoltativamente, SSE legacy su/ssenella tua app Express. Le opzioni controllano limiti delle sessioni, timeout di inattività, CORS e protezione dal DNS rebinding.startAdminServer()aggiunge l’interfaccia di amministrazione e usa i limiti delle sessioni predefiniti.attachSseRoutes()resta disponibile come wrapper deprecato con argomenti posizionali.
Server di amministrazione
startAdminServer() avvia un’app Express che fornisce:
- la console web per caricare o incollare specifiche, esaminare strumenti, prompt e risorse e visualizzare servizi attivi e log delle richieste;
- i trasporti HTTP di MCP;
- autenticazione tramite chiave API, log delle richieste con oscuramento degli header sensibili e persistenza facoltativa dello stato.
Installazione
npm install @powerduck/openapi-mcp-server
Guida rapida
openapi-mcp serve --transport web --port 3000 --api-key your-admin-key
Passaggi successivi
- Installazione — npm/yarn/pnpm, installazione globale, sottopercorso
./servere dipendenze. - Guida rapida — Uso da CLI e dal codice.
- Configurazione — Descrizione completa di
ServerConfig. - Riferimento API — Tutte le esportazioni e i comandi CLI.
- Esempi — Esempi pratici.
Licenza
MIT.