Skip to content

Commit 0306841

Browse files
committed
docs(architecture): add architecture diagrams
1 parent bbd38f2 commit 0306841

File tree

1 file changed

+94
-0
lines changed

1 file changed

+94
-0
lines changed

README.md

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ Read the docs with demo videos [here](https://nicholas-goh.com/docs/intro?ref=fa
77
- [Core Features](#core-features)
88
- [Technology Stack and Features](#technology-stack-and-features)
99
- [Planned Features](#planned-features)
10+
- [Architecture](#architecture)
11+
- [Inspector](#inspector)
12+
- [Template Setup](#template-setup)
13+
- [Reverse Proxy](#reverse-proxy)
14+
- [Monitoring and Observability](#monitoring-and-observability)
1015
- [Getting Started](#getting-started)
1116
- [Development](#development)
1217
- [VSCode Devcontainer](#vscode-devcontainer)
@@ -50,6 +55,95 @@ Read the docs with demo videos [here](https://nicholas-goh.com/docs/intro?ref=fa
5055
- Provision with [![Terraform](https://img.shields.io/github/stars/hashicorp/terraform?logo=terraform&label=Terraform)](https://github.com/hashicorp/terraform) IaC
5156
- Push built images to ECR and Dockerhub
5257

58+
## Architecture
59+
60+
### Inspector
61+
62+
Inspector communicates via SSE protocol with each MCP Server, while each server adheres to MCP specification.
63+
64+
```mermaid
65+
graph LR
66+
67+
subgraph localhost
68+
A[Inspector]
69+
B[DBHub Server]
70+
C[Youtube Server]
71+
D[Custom Server]
72+
end
73+
74+
subgraph Supabase Cloud
75+
E[Supabase DB]
76+
end
77+
78+
subgraph Google Cloud
79+
F[Youtube API]
80+
end
81+
82+
A<-->|Protocol|B
83+
A<-->|Protocol|C
84+
A<-->|Protocol|D
85+
B<-->E
86+
C<-->F
87+
```
88+
89+
### Template Setup
90+
91+
The current template does not connect to all MCP servers. Additionally, the API server communicates with the database using a SQL ORM.
92+
93+
```mermaid
94+
graph LR
95+
96+
subgraph localhost
97+
A[API Server]
98+
B[DBHub Server]
99+
C[Youtube Server]
100+
D[Custom Server]
101+
end
102+
103+
subgraph Supabase Cloud
104+
E[Supabase DB]
105+
end
106+
107+
A<-->|Protocol|D
108+
A<-->E
109+
```
110+
111+
### Reverse Proxy
112+
113+
```mermaid
114+
graph LR
115+
A[Web Browser]
116+
117+
subgraph localhost
118+
B[Nginx Reverse Proxy]
119+
C[API Server]
120+
end
121+
122+
A-->B
123+
B-->C
124+
```
125+
126+
### Monitoring and Observability
127+
128+
```mermaid
129+
graph LR
130+
131+
subgraph localhost
132+
A[API Server]
133+
end
134+
135+
subgraph Grafana Cloud
136+
B[Grafana]
137+
end
138+
139+
subgraph Langfuse Cloud
140+
C[Langfuse]
141+
end
142+
143+
A -->|Metrics & Logs| B
144+
A -->|Traces & Events| C
145+
```
146+
53147
## Getting Started
54148

55149
Build community youtube MCP image with:

0 commit comments

Comments
 (0)