Registry / llm-agents / openapi-mcp-server

openapi-mcp-server

library0.2.1jsnpmunverified

An MCP (Model Context Protocol) server (v2.1.0) that enables AI assistants like Claude and Cursor to search and explore OpenAPI specifications through oapis.org. It follows a three-step process: identifying the needed OpenAPI identifier, fetching a plain-language summary, and examining specific endpoints. Unlike v1, v2 focuses purely on exploration and code generation without executing API calls, since authentication is not yet standardized in MCP. Supports JSON and YAML. Node.js >=18 required, ESM-only, published on npm.

llm-agents http-networking web-framework devops

npm install openapi-mcp-server

package ↗

INSTALL

IMPORT

SIG · OPENAPI-MCP-SERVER

openapi-mcp-server

llm-agentsjavascriptv0.2.1

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

OpenAPIMCPServer

✓ import OpenAPIMCPServer from 'openapi-mcp-server'

✗ const OpenAPIMCPServer = require('openapi-mcp-server')

ESM-only since v2; CJS require() will throw. Default import.

getOpenAPISummary

✓ import { getOpenAPISummary } from 'openapi-mcp-server'

Named export for fetching a plain-language summary of an OpenAPI spec.

getEndpointDetails

✓ import { getEndpointDetails } from 'openapi-mcp-server'

Creates and starts an OpenAPI MCP server using the stdio transport, enabling AI assistants to search and explore OpenAPI specs.

import OpenAPIMCPServer from 'openapi-mcp-server'; import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js'; const server = new OpenAPIMCPServer(); const transport = new StdioServerTransport(); await server.connect(transport); console.error('OpenAPI MCP Server running on stdio');

Debug

Known issues

breakingV2 is a complete rewrite: no tool execution, no authentication handling. V1 APIs are removed.

fix

If you relied on v1's ability to call endpoints directly, do not upgrade. Stay on v1.x (e.g., `npm install openapi-mcp-server@1.2.0`).

affects: >=2.0.0 <3.0.0

deprecatedV1.x is deprecated and no longer maintained. All development effort is on v2.

fix

Migrate to v2 if you only need exploration; otherwise consider alternative MCP servers that support API execution.

affects: <2.0.0

gotchaPackage is ESM-only from v2. Using `require()` throws a runtime error.

fix

Use `import` statements. Ensure `"type": "module"` in your package.json.

affects: >=2.0.0

gotchaNode.js 18+ is required. Older versions fail with SyntaxError or missing APIs.

fix

Update Node.js to 18 or newer (e.g., using nvm).

affects: >=2.0.0

Errors

Common errors & fixes

Error [ERR_REQUIRE_ESM]: require() of ES Module /path/to/node_modules/openapi-mcp-server/index.js not supported.

Package is ESM-only since v2, but you used require().

fix

Change to `import OpenAPIMCPServer from 'openapi-mcp-server'`. If you cannot use ESM, stay on v1.x.

TypeError: OpenAPIMCPServer is not a constructor

Default import was used incorrectly or the module exports differently.

fix

Use `import OpenAPIMCPServer from 'openapi-mcp-server'` (no curly braces). The default export is the class.

Upgrade

Version history

0.2.1latest on npm

Audit

Dependencies

@modelcontextprotocol/sdkrequiredProvides the MCP server framework for tool/request handling

Agent activity

18 hits · last 30 days

node

OpenAI (training)

Resources

packagehttps://www.npmjs.com/package/openapi-mcp-server ↗