# mcp-gateway

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

## Basic Information

- **Project Name**: mcp-gateway
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: feat/support-docker
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-04-28
- **Last Updated**: 2025-04-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# MCP Gateway

[![English](https://img.shields.io/badge/English-Click-yellow)](README.md)
[![简体中文](https://img.shields.io/badge/简体中文-点击查看-orange)](./docs/README.zh-CN.md)

MCP Gateway is a lightweight yet highly available gateway service developed in Go, designed to help individuals and businesses easily convert their existing API services (RESTful, gRPC, etc.) into MCP-Servers through configuration under the wave of MCP (Model Control Protocol).

Clear Purpose and Key Features:
- 🌐 **Platform Agnostic**: Can be integrated easily in any environment—bare metal, virtual machines, ECS, K8s—without touching the infrastructure.
- 🔁 **Multi-protocol Conversion**: Supports converting RESTful and gRPC APIs to MCP-Server through configuration.
- ⚡️ **High Performance and Replication-Friendly**: Lightweight without compromising availability and performance.
- 🧭 **User-Friendly Management UI**: Minimizes learning and maintenance costs.

https://github.com/user-attachments/assets/2a812a14-85cf-45d6-9f37-cc08d8579b33

## Features

- ⚙️ Zero-intrusion integration
- 🪶 Lightweight and easy to deploy
- 💡 Transparent pass-through for headers, parameters, body, and response
- 🧭 Intuitive admin interface

## TODOs

- [x] Convert RESTful API to MCP-Server
- [ ] Convert gRPC to MCP-Server
- [x] Request/Response body transformation
- [x] Management interface
- [ ] Session persistence
- [x] Streamable HTTP support
- [ ] Migratable and restorable sessions
- [ ] Pre-request authentication
- [ ] Configuration versioning
- [ ] Distributed configuration persistence
- [ ] Multi-replica service support
- [ ] Docker support
- [ ] Kubernetes integration
- [ ] Helm chart support

## Quick Start

### Backend Service

#### Gateway Service

1. Clone the project
    ```bash
    git clone https://github.com/mcp-ecosystem/mcp-gateway.git
    cd mcp-gateway
    ```

2. Install dependencies
    ```bash
    go mod download
    ```

3. Run the service
    ```bash
    go run ./cmd/mcp-gateway/main.go
    ```

#### Management Service

1. Clone the project
    ```bash
    git clone https://github.com/mcp-ecosystem/mcp-gateway.git
    cd mcp-gateway
    ```

2. Install dependencies
    ```bash
    go mod download
    ```

3. Run the service
    ```bash
    go run cmd/apiserver/main.go
    ```

### Frontend Development

1. Navigate to the frontend directory
    ```bash
    cd web
    ```

2. Install dependencies
    ```bash
    npm install
    ```

3. Start the development server
    ```bash
    npm run dev
    ```

## Project Structure

```
.
├── cmd/            # Backend service entry points
├── configs/        # Configuration files
├── internal/       # Internal packages
├── pkg/            # Shared packages
├── web/            # Frontend code
└── docs/           # Project documentation
```

## Configuration

Configuration files are located in the `configs` directory and support YAML format. Key configuration items include:

- 🖥️ Server settings
- 🔀 Routing rules
- 🔐 Tool permissions
- ⚙️ System parameters

## Contribution Guide

1. Fork the project
2. Create a feature branch
3. Commit your changes
4. Push to your branch
5. Create a Pull Request

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.