This package provides a server implementation for converting OpenAPI Specification (OAS) files to Model Context Protocol (MCP) format. It allows you to transform your API definitions into a structure compatible with MCP for improved model interactions.
To install the oas-to-mcp package and its dependencies, ensure you have Bun installed on your system, then run:
bun install
Start the MCP server with the following command:
bun run index.ts
The server will initialize and begin listening for incoming requests to transform your OpenAPI specifications into MCP format.
By default, the server uses standard configuration settings. You can modify these by editing the configuration parameters in the project files before starting the server.
Once the server is running, you can send HTTP requests to convert your OpenAPI specifications:
curl -X POST http://localhost:3000/convert \
-H "Content-Type: application/json" \
-d @path/to/your/openapi.json
If you encounter any issues while running the server:
To add this MCP server to Claude Code, run this command in your terminal:
claude mcp add-json "oas-to-mcp" '{"command":"bun","args":["run","index.ts"]}'
See the official Claude Code MCP documentation for more details.
There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json
file so that it is available in all of your projects.
If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json
file.
To add a global MCP server go to Cursor Settings > Tools & Integrations and click "New MCP Server".
When you click that button the ~/.cursor/mcp.json
file will be opened and you can add your server like this:
{
"mcpServers": {
"oas-to-mcp": {
"command": "bun",
"args": [
"run",
"index.ts"
]
}
}
}
To add an MCP server to a project you can create a new .cursor/mcp.json
file or add it to the existing one. This will look exactly the same as the global MCP server example above.
Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.
The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.
You can also explicitly ask the agent to use the tool by mentioning the tool name and describing what the function does.
To add this MCP server to Claude Desktop:
1. Find your configuration file:
~/Library/Application Support/Claude/claude_desktop_config.json
%APPDATA%\Claude\claude_desktop_config.json
~/.config/Claude/claude_desktop_config.json
2. Add this to your configuration file:
{
"mcpServers": {
"oas-to-mcp": {
"command": "bun",
"args": [
"run",
"index.ts"
]
}
}
}
3. Restart Claude Desktop for the changes to take effect