MCP Proxy

🚀 MCP-Proxy User Guide

MCP-Proxy is a powerful proxy server tool that supports multiple protocols and advanced features. Here is a detailed guide on how to use MCP-Proxy.

🚀 Quick Start

Installation

You can download MCP-Proxy from GitHub or install it using the following command:

pip install mcpy

Configuration

Create a configuration file mcp-config.ini and add the following content:

[proxy]
mode = sse
port = 8096
host = localhost

[target]
command = uvx mcp-server-fetch
args =
environment = true

Basic Usage

Start the proxy server:

mcp-proxy --mode sse --port 8096 uvx mcp-server-fetch

✨ Features

Advanced Features

Load Balancing

Use the load balancing mode:

mcp-proxy --mode sse --port 8096 --balance round-robin uvx1 mcp-server-fetch
mcp-proxy --mode sse --port 8097 --balance least-connections uvx2 mcp-server-fetch

Environment Variable Passing

Enable environment variable passing:

MCP_PASS_ENVIRONMENT=true mcp-proxy --mode sse --port 8096 uvx mcp-server-fetch

📦 Installation

Install the mcp-proxy Tool

Install the mcp-proxy tool using the following command:

python -m pip install --user mcpy

Then, add the mcpy script to your PATH environment variable so that you can use it directly in the terminal.

Verify the Installation

After the installation is complete, run the following command in the terminal to verify if the installation was successful:

mcp-proxy --version

💻 Usage Examples

Run the Proxy in SSE Mode

To run mcp-proxy in SSE (Server-Sent Events) mode, follow these steps:

1. Start a local server:

mcp-proxy --mode sse --port 8096 uvx mcp-server-fetch &> server.log &

2. In another terminal window, start the proxy to connect to the SSE server:

mcp-proxy http://localhost:8096/sse

3. Press Ctrl+C to stop the proxy.

Run the Proxy in Stdio Mode

To run mcp-proxy in Stdio mode, follow these steps:

1. Start a local server:

mcp-proxy --mode stdio --port 8096 uvx mcp-server-fetch &> server.log &

2. In another terminal window, start the proxy to connect to the Stdio server:

mcp-proxy http://localhost:8096/stdio

3. Press Ctrl+C to stop the proxy.

Implement an API Gateway Using MCP-Proxy

Here is a tutorial on how to use MCP-Proxy to implement a simple API gateway:

1. Install the dependencies:

pip install mcpy requests

2. Create the gateway logic code gateway.py:

from flask import Flask, request, jsonify

app = Flask(__name__)

@app.route('/api', methods=['GET'])
def handle_request():
    # Process request headers and parameters
    headers = request.headers
    params = request.args

    # Call the backend service
    response = requests.get(f"http://backend:8096/api", headers=headers, params=params)

    # Process the response
    return jsonify(response.json())

if __name__ == '__main__':
    app.run(port=8095)

3. Start the gateway service:

python gateway.py

4. Configure MCP-Proxy to proxy to the gateway:

mcp-proxy --mode sse --port 8096 gateway:8095

5. Test the API call:

curl http://localhost:8096/api

📚 Documentation

JSON Configuration File Format

Here is a complete example of the MCP-Proxy configuration file:

{
  "proxy": {
    "command": "mcp-proxy",
    "args": [
      "--mode",
      "sse",
      "--port",
      "8096"
    ],
    "passEnvironment": true
  },
  "fetch": {
    "command": "uvx",
    "args": [
      "mcp-server-fetch"
    ]
  }
}

Environment Variable Configuration

Here is a list of environment variables supported by MCP-Proxy:

Command-Line Configuration

Here are the command-line options supported by MCP-Proxy:

usage: mcp-proxy [-h] [--mode {sse,stdio}] [--port PORT] [--host HOST]
                 [--pass-environment] [--debug] [command_or_url] [args ...]

Start the MCP proxy in one of two possible modes: as an SSE or stdio client.

optional arguments:
  -h, --help            Show help message and exit
  --mode {sse,stdio}   Set the proxy mode. Valid values are `sse` or `stdio`.
  --port PORT          Set the listening port of the proxy server.
  --host HOST          Set the binding address of the proxy server.
  --pass-environment   Whether to pass all environment variables to the child process.
  --debug              Enable debug mode

command_and_url: The command or target URL to execute
args...               Additional arguments to pass to the command

Command-Line Options

Here is a complete list of command-line options supported by MCP-Proxy:

Configuration File

Here is the configuration file format supported by MCP-Proxy:

[proxy]
mode = sse
port = 8096
host = localhost

[target]
command = uvx mcp-server-fetch
args = 
environment = true

Environment Variables

Here is a list of environment variables supported by MCP-Proxy:

🔧 Technical Details

Docker Integration

Create a Docker Image

FROM python:3.9-slim

WORKDIR /app

COPY requirements.txt .
RUN pip install --no-cache-dir -r requirements.txt

COPY . .

CMD ["mcp-proxy"]

Run a Docker Container

docker build -t mcp-proxy .
docker run -it mcp-proxy

Proxy Chain Configuration

Here is an example of the proxy chain configuration supported by MCP-Proxy:

# Basic proxy chain
mcp-proxy --mode sse --port 8096 uvx mcp-server-fetch

# Nested proxy chain
mcp-proxy --mode sse --port 8096 "uvx mcp-server-fetch"

High Availability Configuration

Here is an example of the high availability configuration of MCP-Proxy:

# Use load balancing
mcp-proxy --mode sse --port 8096 --balance round-robin uvx1 mcp-server-fetch
mcp-proxy --mode sse --port 8097 --balance least-connections uvx2 mcp-server-fetch

# Use failover
mcp-proxy --mode sse --port 8096 --failover active-passive uvx1 mcp-server-fetch

📄 License

The MCP-Proxy project is licensed under the MIT License. Please refer to the LICENSE file for detailed information.

Community

Forums and Discussion Groups

Contribution Guidelines

1. Fork the project repository:

git clone https://github.com/your-org/mcp-proxy.git
cd mcp-proxy

2. Create a feature branch:

git checkout -b feature/new-feature

3. Commit your changes:

git add .
git commit -m "Add new feature"
git push origin feature/new-feature

4. Submit a Pull Request to the main repository.

Development Team

• Core Developers:

  • John Doe john.doe@example.com
  • Jane Smith jane.smith@example.com

• Contributors:

  • Alice Brown alice.brown@example.com
  • Bob Wilson bob.wilson@example.com

Contact Information

Author Information

• Name: John Doe
• Email: john.doe@example.com
• GitHub: https://github.com/johndoe

Support and Feedback

If you have any questions or suggestions, please feel free to contact us through the following methods:

• Email: support@mcp-proxy.com
• GitHub Repository: MCP-Proxy
• Discord Community: Join our Discord server

Thank you for choosing MCP-Proxy! We look forward to your feedback and suggestions to help us continuously improve and optimize this project.