Skip to content

Commit 5e584c9

Browse files
committed
Add mermaid diagram with Gateway overview
1 parent 3cce23e commit 5e584c9

File tree

2 files changed

+92
-0
lines changed

2 files changed

+92
-0
lines changed

README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,52 @@ MCP Gateway builds on the MCP spec by sitting **in front of** MCP Server or REST
1515
* **Adapt** arbitrary REST/HTTP APIs into MCP tools with JSON-Schema input validation, retry/rate-limit policies and transparent JSON-RPC invocation
1616
* **Simplify** deployments with a full admin UI, rich transports, pre-built DX pipelines and production-grade observability
1717

18+
```mermaid
19+
graph TD
20+
subgraph UI_and_Auth
21+
UI[🖥️ Admin UI]
22+
Auth[🔐 Auth - JWT and Basic]
23+
UI --> Core
24+
Auth --> Core
25+
end
26+
27+
subgraph Gateway_Core
28+
Core[🚪 MCP Gateway Core]
29+
Protocol[📡 Protocol - Init Ping Completion]
30+
Federation[🌐 Federation Manager]
31+
Transports[🔀 Transports - HTTP WS SSE Stdio]
32+
33+
Core --> Protocol
34+
Core --> Federation
35+
Core --> Transports
36+
end
37+
38+
subgraph Services
39+
Tools[🧰 Tool Service]
40+
Resources[📁 Resource Service]
41+
Prompts[📝 Prompt Service]
42+
Servers[🧩 Server Service]
43+
44+
Core --> Tools
45+
Core --> Resources
46+
Core --> Prompts
47+
Core --> Servers
48+
end
49+
50+
subgraph Persistence
51+
DB[💾 Database - SQLAlchemy]
52+
Tools --> DB
53+
Resources --> DB
54+
Prompts --> DB
55+
Servers --> DB
56+
end
57+
58+
subgraph Caching
59+
Cache[⚡ Cache - Redis or Memory]
60+
Core --> Cache
61+
end
62+
```
63+
1864
---
1965

2066
## Features

docs/docs/index.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,52 @@ A flexible FastAPI-based gateway and router for **Model Context Protocol (MCP)**
3030
- **Security**: JWT and Basic Auth, rate limits, SSL validation
3131
- **Caching & Observability**: In-memory or Redis/database-backed LRU+TTL caching, structured logs
3232

33+
```mermaid
34+
graph TD
35+
subgraph UI_and_Auth
36+
UI[🖥️ Admin UI]
37+
Auth[🔐 Auth - JWT and Basic]
38+
UI --> Core
39+
Auth --> Core
40+
end
41+
42+
subgraph Gateway_Core
43+
Core[🚪 MCP Gateway Core]
44+
Protocol[📡 Protocol - Init Ping Completion]
45+
Federation[🌐 Federation Manager]
46+
Transports[🔀 Transports - HTTP WS SSE Stdio]
47+
48+
Core --> Protocol
49+
Core --> Federation
50+
Core --> Transports
51+
end
52+
53+
subgraph Services
54+
Tools[🧰 Tool Service]
55+
Resources[📁 Resource Service]
56+
Prompts[📝 Prompt Service]
57+
Servers[🧩 Server Service]
58+
59+
Core --> Tools
60+
Core --> Resources
61+
Core --> Prompts
62+
Core --> Servers
63+
end
64+
65+
subgraph Persistence
66+
DB[💾 Database - SQLAlchemy]
67+
Tools --> DB
68+
Resources --> DB
69+
Prompts --> DB
70+
Servers --> DB
71+
end
72+
73+
subgraph Caching
74+
Cache[⚡ Cache - Redis or Memory]
75+
Core --> Cache
76+
end
77+
```
78+
3379
---
3480

3581
## Audience

0 commit comments

Comments
 (0)