إنتقل إلى المحتوى الرئيسي

التثبيت

المتطلبات​

  • 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

تحتوي واجهة سطر الأوامر على أمر واحد هو 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 للإدارة وبرمجيات وسيطة للمصادقة (startAdminServer، createAuthMiddleware).

اعتماديات وقت التشغيل​

تُثبّت هذه الاعتماديات تلقائيًا مع الحزمة:

  • @modelcontextprotocol/sdk — تنفيذ بروتوكول MCP.
  • @powerduck/openapi-parser — التحقق من OpenAPI وحل المراجع وترقية الإصدار.
  • express و cors — خادم HTTP للإدارة وCORS.
  • axios — عميل HTTP للوصول إلى الخادم المستهدف عند تنفيذ الأدوات.
  • commander — إطار عمل سطر الأوامر.
  • js-yaml — تحليل YAML.
  • multer — معالجة رفع المواصفات.
  • terser — تصغير ملفات واجهة الويب المضمّنة.

التحقق​

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

الخطوات التالية​