Перейти к основному содержимому

Установка

Требования​

  • Node.js >=22.12.0 (указано в engines).

Установка​

npm install @powerduck/openapi-mcp-server

Yarn:

yarn add @powerduck/openapi-mcp-server

pnpm:

pnpm add @powerduck/openapi-mcp-server

CLI​

Пакет регистрирует программу 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 содержит одну команду serve (см. Быстрый старт).

ESM / CommonJS​

Оба формата сборки включают декларации типов. Дополнительные @types/* не нужны:

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

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

Экспорт подпути​

ИмпортСодержимое
@powerduck/openapi-mcp-serverОсновная библиотека: загрузка спецификаций, создание инструментов, промптов и ресурсов, выполнение запросов, построение MCP-сервера, транспорты stdio и HTTP.
@powerduck/openapi-mcp-server/serverАдминистративный HTTP-сервер и middleware аутентификации (startAdminServer, createAuthMiddleware).

Зависимости времени выполнения​

Эти зависимости устанавливаются автоматически вместе с пакетом:

  • @modelcontextprotocol/sdk — реализация протокола MCP.
  • @powerduck/openapi-parser — валидация OpenAPI, разыменование ссылок и обновление версии.
  • express и cors — административный HTTP-сервер и CORS.
  • axios — HTTP-клиент для обращения к целевому серверу при выполнении инструментов.
  • commander — фреймворк CLI.
  • js-yaml — разбор YAML.
  • multer — обработка загрузки спецификаций.
  • terser — минификация ресурсов встроенного веб-интерфейса.

Проверка​

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

Дальнейшие шаги​