Openapi MCP Converter

🚀 OpenAPI to MCP Server Converter

A tool for automatically converting OpenAPI specifications into Model Context Protocol (MCP) server instances

🚀 Quick Start

Prerequisites

• Node.js version 18+
• TypeScript version 5.x

Basic Usage

Install the package:

npm install openapi-mcp-converter

Run a local Standard Input Output (stdio) MCP server:

import fs from 'fs';
import { OpenApiMCPSeverConverter } from '../index.js';
import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js';
import path from 'path';
import { fileURLToPath } from 'url';

const openApiDoc = JSON.parse(fs.readFileSync(path.join(path.dirname(fileURLToPath(import.meta.url)), 'openapi.json'), 'utf8'));

const converter = new OpenApiMCPSeverConverter(openApiDoc, { timeout: 100000 });
const server = converter.getServer();
console.log(JSON.stringify(converter.getMcpTools(), null, 2));
console.log(JSON.stringify(converter.getTools(), null, 2));
async function runServer() {
  const transport = new StdioServerTransport();
  await server.connect(transport);
  console.log("GitHub MCP Server is running on stdio");
}

runServer().catch((error) => {
  console.error("Fatal error in the main program:", error);
  process.exit(1);
});

Run Example

npm run test    # Execute example test cases

✨ Features

• 🚀 Automated Conversion: Automatically parses OpenAPI 3.0 specifications.
• 🛠 Type Safety: Based on TypeScript's strong type validation.
• 🔄 Request Proxy: Automatically handles tool call parameter mapping.

📚 Documentation

Project Structure

/openapi-to-mcp
├── dist/        # Compiled output directory
├── src/         # Source code directory
│   ├── example/ # Example configuration files
│   └── index.ts # Core implementation file
├── package.json
└── tsconfig.json

Build Commands

npm run build    # Build for production environment
npm run watch    # Real-time monitoring build in development mode