@@ -9,28 +9,32 @@ owner: Mihai Criveti
9
9
A flexible FastAPI-based gateway and router for ** Model Context Protocol (MCP)** with support for virtual servers. It acts as a unified interface for tools, resources, prompts, virtual servers, and federated gateways — all accessible via rich multi-transport APIs and an interactive web-based Admin UI.
10
10
11
11
![ MCP Gateway] ( images/mcpgateway.gif )
12
+
12
13
---
13
14
14
15
## What it Does
15
16
16
17
- 🚪 Acts as a ** gateway layer** in front of MCP servers or APIs
17
- - 🔗 Connects and federates multiple MCP backends (auto-discovery, failover , merging)
18
- - 🔄 Adapts any REST API into an MCP- compliant tool or server
18
+ - 🔗 Connects and federates multiple MCP backends (auto-discovery, fail-over , merging)
19
+ - 🔄 Virtualizes REST APIs and external MCP servers as compliant tools and servers
19
20
- 🛠️ Centralizes registration and management of tools, prompts, and resources
20
- - 📡 Exposes all endpoints over HTTP/JSON-RPC, WebSocket, Server-Sent Events (SSE), and stdio
21
+ - 📡 Exposes all endpoints over HTTP/JSON-RPC, WebSocket, Server-Sent Events (SSE), and ** stdio**
22
+ - 📦 Provides a stdio wrapper (` mcpgateway-wrapper ` ) for terminal-based or headless MCP clients
21
23
22
24
---
23
25
24
26
## Key Features
25
27
26
- - ** Multi-Transport Support** : HTTP, WebSocket, SSE, and stdio support with auto-negotiation
27
- - ** Federation & Health Checks** : Auto-discovery, syncing, and monitoring of peer gateways
28
- - ** Admin UI** : Visual management of servers, tools, prompts, and resources (HTMX + Tailwind)
29
- - ** Tool Wrapping** : Expose REST, CLI, or local functions as JSON-RPC tools
30
- - ** Security** : JWT and Basic Auth, rate limits, SSL validation
31
- - ** Caching & Observability** : In-memory or Redis/database-backed LRU+TTL caching, structured logs
28
+ - ** Multi-Transport** : HTTP, WebSocket, SSE, and stdio with auto-negotiation
29
+ - ** Federation & Health Checks** : Auto-discovery (mDNS or static), syncing, monitoring
30
+ - ** Admin UI** : Real-time management (HTMX + Tailwind)
31
+ - ** Tool Wrapping** : REST / CLI / local functions with JSON-Schema validation
32
+ - ** Security** : JWT + Basic Auth, custom headers, rate limits, SSL control
33
+ - ** Caching & Observability** : Redis/in-memory/database caching, metrics, structured logs
34
+ - ** Virtual Servers** : Group tools/resources/prompts into MCP-compliant servers
35
+ - ** Wrapper Mode** : ` mcpgateway-wrapper ` turns any remote gateway into a local stdio MCP server
32
36
33
- For a list of upcoming features, check out the [ ContextForge MCP Gateway Roadmap] ( architecture/roadmap.md )
37
+ For upcoming capabilities, see the [ Roadmap] ( architecture/roadmap.md ) .
34
38
35
39
``` mermaid
36
40
graph TD
@@ -46,7 +50,6 @@ graph TD
46
50
Protocol[📡 Protocol - Init Ping Completion]
47
51
Federation[🌐 Federation Manager]
48
52
Transports[🔀 Transports - HTTP WS SSE Stdio]
49
-
50
53
Core --> Protocol
51
54
Core --> Federation
52
55
Core --> Transports
@@ -57,7 +60,6 @@ graph TD
57
60
Resources[📁 Resource Service]
58
61
Prompts[📝 Prompt Service]
59
62
Servers[🧩 Server Service]
60
-
61
63
Core --> Tools
62
64
Core --> Resources
63
65
Core --> Prompts
@@ -82,30 +84,59 @@ graph TD
82
84
83
85
## Audience
84
86
85
- MCP Gateway is designed for :
87
+ MCP Gateway serves :
86
88
87
- - ** AI Platform Teams** that want to securely expose a variety of tools and models behind a consistent protocol
88
- - ** DevOps Engineers** looking for self-hostable control planes
89
- - ** Open-source contributors** building agents, clients, and adapters against MCP
90
- - ** Cloud Architects** deploying on Kubernetes, IBM Code Engine, AWS, or Azure
89
+ * ** AI Platform Teams** building unified gateways for LLM tools & services
90
+ * ** DevOps Engineers** deploying secure, observable, federated control planes
91
+ * ** Open-source contributors** extending MCP tooling or adapters
92
+ * ** Cloud Architects** running on Kubernetes, IBM Code Engine, AWS, Azure, or bare Docker
93
+
94
+ ---
95
+
96
+ ## Installation & Deployment
97
+
98
+ | Scenario | One-liner / CLI Snippet | Docs |
99
+ | ----------------------------- | ---------------------------------------------------------------------------------------------------- | ------------------------------------------------ |
100
+ | ** Local (PyPI)** | ` pip install mcp-contextforge-gateway && mcpgateway --host 0.0.0.0 --port 4444 ` | [ Quick Start] ( overview/quick_start.md ) |
101
+ | ** Docker / Podman** | ` docker run -p 4444:4444 ghcr.io/ibm/mcp-context-forge:<tag> ` | [ Containers] ( deployment/container.md ) |
102
+ | ** Docker-Compose (dev)** | ` docker compose up ` | [ Compose] ( deployment/compose.md ) |
103
+ | ** Helm / Vanilla Kubernetes** | ` helm repo add mcpgw https://IBM.github.io/mcp-context-forge && helm install mcpgw mcpgw/mcpgateway ` | [ Helm Chart] ( deployment/helm.md ) |
104
+ | ** Minikube (local k8s)** | ` make minikube ` | [ Minikube Guide] ( deployment/minikube.md ) |
105
+ | ** OpenShift / OKD** | ` oc apply -k openshift/ ` | [ OpenShift] ( deployment/openshift.md ) |
106
+ | ** Argo CD / GitOps** | ` kubectl apply -f argo.yaml ` | [ Argo CD] ( deployment/argocd.md ) |
107
+ | ** IBM Cloud – Code Engine** | ` ibmcloud ce app create --name mcpgw --image ghcr.io/ibm/mcp-context-forge:<tag> ` | [ IBM Code Engine] ( deployment/ibm-code-engine.md ) |
108
+ | ** AWS – ECS (Fargate)** | ` aws ecs create-service --cli-input-json file://ecs.json ` | [ AWS Guide] ( deployment/aws.md ) |
109
+ | ** AWS – EKS (Helm)** | ` helm install mcpgw mcpgw/mcpgateway ` | [ AWS Guide] ( deployment/aws.md ) |
110
+ | ** Google Cloud Run** | ` gcloud run deploy mcpgw --image ghcr.io/ibm/mcp-context-forge:<tag> ` | [ GCP Cloud Run] ( deployment/google-cloud-run.md ) |
111
+ | ** Google GKE (Helm)** | ` helm install mcpgw mcpgw/mcpgateway ` | [ GCP Guide] ( deployment/google-cloud-run.md ) |
112
+ | ** Azure – Container Apps** | ` az containerapp up --name mcpgw --image ghcr.io/ibm/mcp-context-forge:<tag> ` | [ Azure Guide] ( deployment/azure.md ) |
113
+ | ** Azure – AKS (Helm)** | ` helm install mcpgw mcpgw/mcpgateway ` | [ Azure Guide] ( deployment/azure.md ) |
114
+
115
+
116
+ > ** PyPI Package** : [ ` mcp-contextforge-gateway ` ] ( https://pypi.org/project/mcp-contextforge-gateway/ )
117
+
118
+ > ** OCI Image** : [ ` ghcr.io/ibm/mcp-context-forge:0.1.1 ` ] ( https://github.com/IBM/mcp-context-forge/pkgs/container/mcp-context-forge )
91
119
92
120
---
93
121
94
122
## Get Started
95
123
96
- Check out the [ Quick Start ] ( overview/index.md ) for installation and usage, or go straight to:
124
+ Jump straight to:
97
125
98
- - [ Features Overview] ( overview/features.md )
99
- - [ Admin UI Walkthrough] ( overview/ui.md )
100
- - [ Deployment Options] ( deployment/index.md )
101
- - [ Using the ` mcpgateway-wrapper ` ] ( using/mcpgateway-wrapper.md )
126
+ * [ Quick Start Guide] ( overview/quick_start.md )
127
+ * [ Features Overview] ( overview/features.md )
128
+ * [ Admin UI Walk-through] ( overview/ui.md )
129
+ * [ Using the ` mcpgateway-wrapper ` ] ( using/mcpgateway-wrapper.md )
130
+ * [ Deployment Options] ( deployment/index.md )
102
131
103
132
!!! note
133
+ Source → [ https://github.com/IBM/mcp-context-forge ] ( https://github.com/IBM/mcp-context-forge )
134
+ Docs → [ https://ibm.github.io/mcp-context-forge/ ] ( https://ibm.github.io/mcp-context-forge/ )
104
135
105
- The latest version can always be found here: <https://github.com/IBM/mcp-context-forge> and for documentation: <https://ibm.github.io/mcp-context-forge/>
106
-
107
- <!-- [Download PDF](pdf/mcpgateway-docs.pdf){ .md-button } [Download DOCX](out/mcpgateway-docs.docx){ .md-button } -->
136
+ ---
108
137
109
138
## Authors and Contributors
110
139
111
- - Mihai Criveti - IBM Distinguished Engineer, Agentic AI
140
+ * ** Mihai Criveti** – IBM Distinguished Engineer, Agentic AI
141
+
142
+ <!-- [Download PDF](pdf/mcpgateway-docs.pdf){ .md-button } [Download DOCX](out/mcpgateway-docs.docx){ .md-button } -->
0 commit comments