Lewati ke konten utama

Instalasi

Persyaratan​

  • Node.js >=22.12.0 (dinyatakan dalam engines).

Instalasi​

npm install @powerduck/openapi-mcp-server

Yarn:

yarn add @powerduck/openapi-mcp-server

pnpm:

pnpm add @powerduck/openapi-mcp-server

CLI​

Paket mendaftarkan program openapi-mcp.

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

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

CLI memiliki satu perintah, yaitu serve (lihat Mulai cepat).

ESM / CommonJS​

Kedua format build menyertakan deklarasi tipe. Tidak diperlukan @types/* tambahan:

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

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

Ekspor subjalur​

ImporIsi
@powerduck/openapi-mcp-serverPustaka inti: memuat spesifikasi, menghasilkan alat/prompt/sumber daya, menjalankan permintaan, membangun server MCP, serta transport stdio dan HTTP.
@powerduck/openapi-mcp-server/serverServer HTTP administrasi dan middleware autentikasi (startAdminServer, createAuthMiddleware).

Dependensi runtime​

Dependensi berikut terinstal otomatis bersama paket:

  • @modelcontextprotocol/sdk — implementasi protokol MCP.
  • @powerduck/openapi-parser — validasi, penyelesaian referensi, dan peningkatan versi OpenAPI.
  • express dan cors — server HTTP administrasi dan CORS.
  • axios — klien HTTP ke layanan tujuan saat menjalankan alat.
  • commander — kerangka CLI.
  • js-yaml — penguraian YAML.
  • multer — penanganan unggahan spesifikasi.
  • terser — minifikasi aset antarmuka web bawaan.

Verifikasi​

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

Langkah berikutnya​