openapi2mcp
by yulinlina
README.md
<div align="center">
# `openapi2mcp`
### Turn any OpenAPI spec into a Model Context Protocol server with one command.
     
<img src="demo.gif" alt="Demo" width="700" />
</div>
---
## 🎯 Why?
MCP is exploding, but every REST API still needs a hand-written MCP server. OpenAPI specs already describe tools, parameters, and schemas, so there is a missing zero-config bridge that turns existing API contracts into MCP tools for Claude, Cursor, and other agents.
**Target audience:** AI application developers and platform engineers who want coding agents to call internal or public REST APIs without writing bespoke MCP servers.
## ✨ Features
- ✨ **Generates MCP tools from OpenAPI paths and schemas**
- ✨ **Runs a minimal MCP stdio server with tools/list and tools/call**
- ✨ **Supports default auth headers, method allowlists, and base URL overrides**
## 🚀 Quick Start
```bash
# Install
pip install openapi2mcp
# Run
openapi2mcp --help
```
## 📦 Installation
### From Source
```bash
git clone https://github.com/YOUR_USERNAME/openapi2mcp.git
cd openapi2mcp
```
```bash
# Create virtual environment
python -m venv .venv
source .venv/bin/activate # Windows: .venv\Scripts\activate
# Install in development mode
pip install -e ".[dev]"
# Run tests
pytest -v
```
## 🎬 Demo
The GIF above was recorded using [Charm VHS](https://github.com/charmbracelet/vhs):
```bash
vhs < demo.tape
```
## 📖 Usage
```bash
# Show help
openapi2mcp --help
# Common usage examples
openapi2mcp --example
```
## 🏗️ Architecture
```mermaid
graph LR
A[Input] --> B[Core Engine]
B --> C[Output]
B --> D[Plugins]
D --> E[Extensions]
```
## 🤝 Contributing
Contributions are welcome! Please:
1. Fork the repo
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request
## 📄 License
MIT © 2026 — See [LICENSE](LICENSE) for details.
---
<div align="center">
**If this project helped you, please ⭐ star it!**
[Made with ❤️ and AI](https://github.com)
</div>
This server cannot be deployed
Maintenance
ActivityMaintained
ResponsivenessNo issues