Skip to main content

A generic MCP gateway whose tools are registered and executed asynchronously by browser applications over WebSocket.

Project description

MCP Gateway

A generic, subclassable Model Context Protocol gateway whose tools are registered and executed asynchronously by connected providers over WebSocket.

MCP Client ⇄ Streamable HTTP ⇄ Gateway ⇄ WebSocket ⇄ Provider

CI PyPI Python License: MIT


The gateway never knows the capabilities ahead of time. A provider — typically a browser app — connects, publishes its own MCP tools, resources, prompts and more, and executes them when an MCP client calls them. The gateway only registers, publishes and routes, staying completely domain agnostic.

It is a small, installable library. You build a real application by subclassing Gateway and overriding hooks. The handlers themselves are written in JavaScript. This library never prescribes a specific frontend — the Provider SDK guide teaches the JS side generically.

📦 Install

pip install mcp-gtw
# or
uv add mcp-gtw

🚀 The smallest gateway

from mcp_gtw.gateway import Gateway

app = Gateway().create_app()
uv run python -m mcp_gtw.main

This publishes a real MCP endpoint at /mcp, a private provider WebSocket at /provider and a health check at /health. It exposes whatever capabilities the connected provider registers.

☁️ One-click deploy

The image runs production-ready as a non-root process. Deploy it to any host that keeps a persistent server (the /provider WebSocket needs one — serverless like Vercel does not work):

Deploy to Render

Render, Railway and Fly.io run the Dockerfile as-is (they inject PORT, which the gateway reads); on a VPS (Hostinger, …) use Docker Compose. Full guide, including reverse proxy and TLS: deployment.

🧩 Extending it

Subclass Gateway and override the hooks to attach your own domain logic:

from mcp_gtw.channel import Channel
from mcp_gtw.gateway import Gateway

class MyGateway(Gateway):
    mcp_server_name = "my-app"

    async def on_provider_connected(self, channel: Channel) -> None:
        ...  # a provider session just came online

    def register_routes(self, app) -> None:
        super().register_routes(app)
        ...  # add your own HTTP and WebSocket routes

app = MyGateway().create_app()

Every behaviour is a swappable strategy with a secure default — authentication, tokens, origins, expiry and the wire codec. Change one by setting a *_class attribute or injecting an instance, without touching the transport. See the Gateway library guide for every override point, Extensibility for the strategy contracts, and Auth recipes for token, username/password and client-supplied-token models.

📚 Documentation

Guide What it covers
Architecture Components, transports and request flows.
Quick start Install, run and connect an MCP client.
Gateway library The Gateway class and every override point.
Extensibility The swappable strategies, their contracts and the invariants.
Auth recipes Token, username/password and client-supplied-token models.
Configuration Every setting and environment variable.
Provider protocol The private gateway ⇄ provider message protocol.
Provider SDK Writing the JavaScript provider and registering tools.
Browser console Turn any open page into a provider from DevTools.
MCP clients Connecting Claude Code, generic clients and the Inspector.
Admin dashboard The optional monitoring dashboard and its stats API.
Security The security model, tokens, origins and hardening.
Testing Running the suite and the 100% coverage gate.
Deployment Docker, reverse proxies and scaling.

🗂️ Layout

.
├── src/mcp_gtw/     # the library
├── tests/               # unit and integration tests (100% coverage)
└── docs/                # the guides linked above

✅ Requirements

  • Python 3.12+ — tested on 3.12, 3.13 and 3.14 in CI (3.12 is the pinned local and Docker version)
  • Any MCP client (Claude Code, Cursor, the MCP Inspector, …)

💜 Support

If this project saved you time, consider supporting it: GitHub Sponsors · Ko-fi.

Made with care by Paulo Coutinho.

Licensed under MIT.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mcp_gtw-0.0.4.tar.gz (362.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcp_gtw-0.0.4-py3-none-any.whl (33.2 kB view details)

Uploaded Python 3

File details

Details for the file mcp_gtw-0.0.4.tar.gz.

File metadata

  • Download URL: mcp_gtw-0.0.4.tar.gz
  • Upload date:
  • Size: 362.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.30 {"installer":{"name":"uv","version":"0.11.30","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for mcp_gtw-0.0.4.tar.gz
Algorithm Hash digest
SHA256 20d9ee3b3b94bb9a04d46cbdc76f285325531c9e872a24f37b604a8a0cca413c
MD5 d70460d1f5f79f89788a42383765a12b
BLAKE2b-256 71d3b32571160daaa267ecc3681bc31a8a875e1d7392ae4c8b265b79788c8451

See more details on using hashes here.

File details

Details for the file mcp_gtw-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: mcp_gtw-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 33.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.30 {"installer":{"name":"uv","version":"0.11.30","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for mcp_gtw-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 5af939513e63fd17d6703abce051322c0b248cf99aa380b52bc972ffb721659b
MD5 b0c29537e5d4de7c313a8c3c632542bb
BLAKE2b-256 4d856c117d168abcf2b08c2e9e22fa636409c4f01aea7e30b8e5a631c1785763

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page