# mcp-gateway

**Repository Path**: zhijingtech/mcp-gateway

## Basic Information

- **Project Name**: mcp-gateway
- **Description**: No description available
- **Primary Language**: Go
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-05-20
- **Last Updated**: 2025-05-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# MCP Gateway

> 🚀 Instantly transform your existing MCP Servers and APIs into [MCP](https://modelcontextprotocol.io/) endpoints — without changing a line of code.

[![English](https://img.shields.io/badge/English-Click-yellow)](./README.md)
[![简体中文](https://img.shields.io/badge/简体中文-点击查看-orange)](docs/README.zh-CN.md)
[![Release](https://img.shields.io/github/v/release/mcp-ecosystem/mcp-gateway)](https://github.com/mcp-ecosystem/mcp-gateway/releases)
[![Docs](https://img.shields.io/badge/Docs-View%20Online-blue)](https://mcp.ifuryst.com)
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/mcp-ecosystem/mcp-gateway)
[![Discord](https://img.shields.io/badge/Discord-Join%20our%20Discord-5865F2?logo=discord&logoColor=white)](https://discord.gg/udf69cT9TY)

---

## 🎯 Support Us on Product Hunt

We just launched **MCP Gateway** on Product Hunt! 🚀  
If you find this project interesting or helpful, we'd love your support.  
Every upvote helps more developers discover it! ❤️

<a href="https://www.producthunt.com/posts/mcp-gateway?embed=true&utm_source=badge-featured&utm_medium=badge&utm_souce=badge-mcp&#0045;gateway" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=958310&theme=light&t=1745767484477" alt="MCP&#0032;Gateway - Turn&#0032;APIs&#0032;into&#0032;MCP&#0032;endpoints&#0044;without&#0032;changing&#0032;a&#0032;line&#0032;of&#0032;code | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>

---

> ⚡ **Note**: MCP Gateway is under rapid development! We strive to maintain backward compatibility, but it cannot be 100% guaranteed. Please make sure to check version changes carefully when upgrading. Due to the fast iteration, documentation updates may sometimes lag behind. If you encounter any issues, feel free to search or ask for help via [Discord](https://discord.gg/udf69cT9TY) or [Issues](https://github.com/mcp-ecosystem/mcp-gateway/issues) ❤️

---

## ✨ What is MCP Gateway?

**MCP Gateway** is a lightweight and highly available gateway service written in Go. It enables individuals and organizations to convert their existing MCP Servers and APIs into services compliant with the [MCP Protocol](https://modelcontextprotocol.io/) — all through configuration, with **zero code changes**.

https://github.com/user-attachments/assets/69480eda-7aa7-4be7-9bc7-cae57fe16c54

### 🔧 Core Design Principles

- ✅ Zero Intrusion: Platform-agnostic, supports deployment on bare metal, VMs, ECS, Kubernetes, etc., without modifying existing infrastructure
- 🔄 Configuration-Driven: Convert legacy APIs to MCP Servers using YAML configuration — no code required
- 🪶 Lightweight & Efficient: Designed for minimal resource usage without compromising on performance or availability
- 🧭 Built-in Management UI: Ready-to-use web interface to simplify setup and reduce operational overhead

---

## 🚀 Getting Started

MCP Gateway supports a ready-to-run Docker deployment. Full deployment and configuration instructions are available in the [docs](https://mcp.ifuryst.com/getting-started/quick-start).

### Quick Launch with Docker

Configure environment variables:

```bash
export OPENAI_API_KEY="sk-eed837fb0b4a62ee69abc29a983492b7PlsChangeMe"
export OPENAI_MODEL="gpt-4o-mini"
export APISERVER_JWT_SECRET_KEY="fec6d38f73d4211318e7c85617f0e333PlsChangeMe"
export SUPER_ADMIN_USERNAME="admin"
export SUPER_ADMIN_PASSWORD="297df52fbc321ebf7198d497fe1c9206PlsChangeMe"
```

Launch the container:

```bash
docker run -d \
  --name mcp-gateway \
  -p 8080:80 \
  -p 5234:5234 \
  -p 5235:5235 \
  -p 5335:5335 \
  -p 5236:5236 \
  -e ENV=production \
  -e TZ=Asia/Shanghai \
  -e OPENAI_API_KEY=${OPENAI_API_KEY} \
  -e OPENAI_MODEL=${OPENAI_MODEL} \
  -e APISERVER_JWT_SECRET_KEY=${APISERVER_JWT_SECRET_KEY} \
  -e SUPER_ADMIN_USERNAME=${SUPER_ADMIN_USERNAME} \
  -e SUPER_ADMIN_PASSWORD=${SUPER_ADMIN_PASSWORD} \
  --restart unless-stopped \
  ghcr.io/mcp-ecosystem/mcp-gateway/allinone:latest
```

### Access and Configuration

1. Access the Web Interface:
   - Open http://localhost:8080/ in your browser
   - Login with the administrator credentials you configured

2. Add an MCP Server:
   - Copy the config from: https://github.com/mcp-ecosystem/mcp-gateway/blob/main/configs/proxy-mock-server.yaml
   - Click "Add MCP Server" in the web interface
   - Paste the configuration and save

### Available Endpoints

After configuration, the service will be available at these endpoints:

- MCP SSE: http://localhost:5235/mcp/user/sse
- MCP SSE Message: http://localhost:5235/mcp/user/message
- MCP Streamable HTTP: http://localhost:5235/mcp/user/mcp

Configure your MCP Client with the `/sse` or `/mcp` suffix URLs to start using it.

### Testing

You can test the service using:

1. The MCP Chat page in the web interface
2. Your own MCP Client (**recommended**)

📖 Read the full guide → [Quick Start »](https://mcp.ifuryst.com/getting-started/quick-start)

---

## 🚀 Core Features

### 🔌 Protocol & Proxy Capabilities
- [x] Support for converting RESTful APIs to MCP Server — Client → MCP Gateway → APIs  
- [x] Support proxying MCP services — Client → MCP Gateway → MCP Servers  
- [ ] Support for converting gRPC to MCP Server — Client → MCP Gateway → gRPC  
- [ ] Support for converting WebSocket to MCP Server — Client → MCP Gateway → WebSocket  
- [x] Support for MCP SSE  
- [x] Support for MCP Streamable HTTP  
- [x] Support for MCP responses including text, images, and audio  

### 🧠 Session & Multi-Tenant Support
- [x] Persistent and recoverable session support  
- [x] Multi-tenant support  
- [ ] Support for grouping and aggregating MCP servers  

### 🛠 Configuration & Management
- [x] Automatic configuration fetching and seamless hot-reloading  
- [x] Configuration persistence (Disk/SQLite/PostgreSQL/MySQL)  
- [x] Configuration sync via OS Signals, HTTP, or Redis PubSub  
- [ ] Version control for configuration  

### 🔐 Security & Authentication
- [ ] OAuth-based pre-authentication support for MCP Servers  

### 🖥 User Interface
- [x] Intuitive and lightweight management UI  

### 📦 Deployment & Operations
- [x] Multi-replica service support  
- [x] Docker support  
- [ ] Kubernetes and Helm deployment support  

---

## 📚 Documentation

For more usage patterns, configuration examples, and integration guides, please visit:

👉 **https://mcp.ifuryst.com**

---

## 📄 License

This project is licensed under the [MIT License](LICENSE).

## 💬 Join Our WeChat Community

Scan the QR code below to add us on WeChat. Please include a note: `mcp-gateway` or `mcpgw`.

<img src="web/public/wechat-qrcode.png" alt="WeChat QR Code" width="350" height="350" />

## 📈 Star History

[![Star History Chart](https://api.star-history.com/svg?repos=mcp-ecosystem/mcp-gateway&type=Date)](https://star-history.com/#mcp-ecosystem/mcp-gateway&Date)