Pular para o conteúdo principal

Instalação

Requisitos​

  • Node.js >=22.12.0 (declarado em engines).

Instalação​

npm install @powerduck/openapi-mcp-server

Yarn:

yarn add @powerduck/openapi-mcp-server

pnpm:

pnpm add @powerduck/openapi-mcp-server

CLI​

O pacote registra o executável openapi-mcp.

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

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

A CLI tem um único comando, serve (consulte Início rápido).

ESM / CommonJS​

Os dois formatos de build incluem declarações de tipos. Não são necessários pacotes @types/* adicionais:

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

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

Exportação de subcaminho​

ImportaçãoConteúdo
@powerduck/openapi-mcp-serverBiblioteca principal: carregamento de especificações, geração de ferramentas, prompts e recursos, execução de requisições, construção do servidor MCP e transportes stdio e HTTP.
@powerduck/openapi-mcp-server/serverServidor HTTP de administração e middleware de autenticação (startAdminServer, createAuthMiddleware).

Dependências de execução​

Estas dependências são instaladas automaticamente com o pacote:

  • @modelcontextprotocol/sdk — implementação do protocolo MCP.
  • @powerduck/openapi-parser — validação, resolução de referências e atualização de OpenAPI.
  • express e cors — servidor HTTP de administração e CORS.
  • axios — cliente HTTP para executar ferramentas contra o servidor de destino.
  • commander — framework da CLI.
  • js-yaml — análise de YAML.
  • multer — processamento do upload de especificações.
  • terser — minificação dos recursos da interface web integrada.

Verificação​

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

Próximos passos​