Mcpproxy

🚀 MCP SSE Proxy Server

The MCP SSE Proxy Server is a proxy server for the MCP protocol based on the SSE (Server-Sent Events) protocol. It supports shared and independent session modes, offers flexible configuration options, and can be integrated with the CURSOR environment.

🚀 Quick Start

Installation

pip install mcp-sse-server

Start the Server

python3 -m mcp.sse_server.run_sse_server --listen "127.0.0.1" --port 8000 --auth_key your_auth_key_here

✨ Features

• Basic Functionality: Provides proxy server functionality for the MCP protocol, supporting the SSE (Server-Sent Events) transmission protocol.
• Architectural Modes:
  • Shared Session Mode: Multiple clients can share the same context data.
  • Independent Session Mode: Each client has its own independent context data.
• Dynamic Configuration:
  • Supports passing environment variables via URL parameters.
  • Offers a simple and easy-to-use configuration method.
• Connection Capabilities:
  • Connects directly to the tool execution environment.
  • Supports CURSOR protocol integration.

📦 Installation

Local Installation

pip install mcp-sse-server

Advanced Installation

# Example: Install using a virtual environment
python3 -m venv mcp_env && \
source mcp_env/bin/activate && \
pip install mcp-sse-server

💻 Usage Examples

Basic Usage

# Example: Run the MCP SSE server locally
python3 -m mcp.sse_server.run_sse_server --listen "::1" --port 8000 --auth_key your_auth_key_here

Advanced Usage

• Tool Execution:

# Example: Configure and start the MCP server with specified tools
python3 -m mcp.sse_server.run_sse_server \
    --listen "0.0.0.0" \
    --port 8000 \
    --auth_key your_auth_key_here \
    --tools 'echo,cat,ls'

• CURSOR Integration:

# Example: Configure the MCP server for the CURSOR environment
python3 -m mcp.sse_server.run_sse_server \
    --listen "127.0.0.1" \
    --port 8000 \
    --auth_key your_auth_key_here \
    --cursor_mode enable

📚 Documentation

Configuration Options

Connection Method

# Example: Connect to the server using curl
curl -X POST "http://127.0.0.1:8000/api" \
  --header "Content-Type: application/json" \
  --data-raw '{"command": "echo", "args": ["hello"]}'

Configuration Example

{
  "server_name": "my_mcp_server",
  "listen_address": "0.0.0.0",
  "port_number": 8000,
  "auth_key": "your_auth_key_here",
  "tools_list": ["echo", "cat", "ls"],
  "cursor_mode": true
}

Logging

# Example: Enable debug-level logging
python3 -m mcp.sse_server.run_sse_server \
    --listen "127.0.0.1" \
    --port 8000 \
    --auth_key your_auth_key_here \
    --log_level debug

Error Handling

• Authentication Failure: 401 Unauthorized
• Internal Error: 500 Internal Server Error

Usage Restrictions

• Maximum Number of Connections: Supports 20 concurrent connections by default, can be configured to expand.
• Tool Restrictions: Only supports the preset tool list.

🔧 Technical Details

Security Features

• Authentication:
  • Supports an authentication mechanism based on URL parameters.
  • Allows for extensible plug-in authentication modules.
• Data Protection:
  • Data transmission uses SSL encryption, enabled by default.
  • Offers flexible security policy configuration options.

Error Handling

Common Errors

• Authentication Failure: The valid authentication key is not correctly configured or passed.
• Port Occupied: The target port is already occupied by another program.
• Tool Missing: The specified tool does not exist in the system.

Exit Status Codes

Error Log Format

LEVEL TIMESTAMP - MSG

📄 License

This project is licensed under the MIT License.

🤝 Contribution Guide

• Code Repository: GitHub Repository
• Issue Feedback: Please submit issues and suggestions in the Issues section.
• Contribution Process:
  1. Fork the repository to your personal account.
  2. Create a feature branch.
  3. Commit your code and push it to the remote repository.
  4. Submit a Pull Request.

🚧 Development Plan

Future Features

• Extended Plug-in Support
• Multi-Protocol Compatibility
• Advanced Security Features

📋 Deployment Guide

Production Environment Configuration

• Reverse Proxy: It is recommended to use Nginx or Apache.
• SSL Certificate: HTTPS must be enabled.
• Log Management: Configure a centralized log collection service.

Monitoring Solution

• Status Monitoring: Regularly check the service running status.
• Performance Metrics: Monitor CPU and memory usage.
• Error Alerts: Set error thresholds to trigger alarms.

📜 Log Examples

Startup Log

INFO: Server started on port 8000 at address ::1
DEBUG: Loaded tools: ['echo', 'cat', 'ls']

Request Log

INFO: Received request from 127.0.0.1:55556
DEBUG: Command received: echo, arguments: ["hello"]
INFO: Completed command execution in 0.002 seconds

Error Log

ERROR: Authentication failed for request from 192.168.1.1:45678
CRITICAL: Server shutting down due to repeated authentication failures