Skip to content

Commit 9982252

Browse files
committed
lint fixes and mermaid diagram updates
- alters the mermaid diagram to use http and not http/sse because sse is http and it allows it to be understood in a streamable http context too Signed-off-by: ChrisJBurns <[email protected]>
1 parent 653f1ca commit 9982252

File tree

2 files changed

+12
-17
lines changed

2 files changed

+12
-17
lines changed

docs/toolhive/guides-k8s/intro.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -36,23 +36,18 @@ The operator introduces a new Custom Resource Definition (CRD) called
3636
flowchart TB
3737
subgraph K8s["<h3>Kubernetes cluster</h3>"]
3838
subgraph K8s1["**Deployment**"]
39-
Svc1["SSE Proxy<br>Service"] -- http/sse --> Proxy1["SSE Proxy<br>Pod"] -- stdio or http/sse --> MCP1["MCP Server<br>Pod"]
39+
Svc1["HTTP Proxy<br>Service"] -- http --> Proxy1["HTTP Proxy<br>Pod"] -- stdio or http --> MCP1["MCP Server<br>Pod"]
4040
Proxy1 -.->|creates| MCP1
4141
end
4242
subgraph K8s2["**Deployment**"]
43-
Svc2["SSE Proxy<br>Service"] -- http/sse --> Proxy2["SSE Proxy<br>Pod"] -- stdio or http/sse --> MCP2["MCP Server<br>Pod"]
43+
Svc2["HTTP Proxy<br>Service"] -- http --> Proxy2["HTTP Proxy<br>Pod"] -- stdio or http --> MCP2["MCP Server<br>Pod"]
4444
Proxy2 -.->|creates| MCP2
4545
end
46-
subgraph K8s3["**Deployment**"]
47-
Svc3["StreamableHTTP Proxy<br>Service"] -- http/StreamableHTTP --> Proxy3["StreamableHTTP Proxy<br>Pod"] -- http/StreamableHTTP --> MCP3["MCP Server<br>Pod"]
48-
Proxy3 -.->|creates| MCP3
49-
end
50-
Ingress["Ingress"] -- http/sse --> Svc1 & Svc2
51-
Ingress["Ingress"] -- http/StreamableHTTP --> Svc3
52-
Operator["ToolHive<br>Operator"] -.->|creates| K8s1 & K8s2 & K8s3
46+
Ingress["Ingress"] -- http --> Svc1 & Svc2
47+
Operator["ToolHive<br>Operator"] -.->|creates| K8s1 & K8s2
5348
end
5449
55-
Client["MCP Client<br>[ex: Copilot]"] -- http/sse or http/streamablehttp --> Ingress
50+
Client["MCP Client<br>[ex: Copilot]"] -- http --> Ingress
5651
```
5752

5853
## Installation

docs/toolhive/guides-k8s/run-mcp-k8s.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -92,11 +92,11 @@ flowchart LR
9292
MCPService --> MCPPod
9393
```
9494

95-
### StreamableHTTP transport flow
95+
### Streamable HTTP transport flow
9696

97-
For MCP servers using StreamableHTTP transport, the proxy creates both a pod and
98-
a headless service. This allows direct HTTP communication between the proxy and
99-
MCP server while maintaining network isolation and service discovery.
97+
For MCP servers using Streamable HTTP transport, the proxy creates both a pod
98+
and a headless service. This allows direct HTTP communication between the proxy
99+
and MCP server while maintaining network isolation and service discovery.
100100

101101
```mermaid
102102
flowchart LR
@@ -113,8 +113,8 @@ flowchart LR
113113
MCPPod["POD: MCP Server"]
114114
end
115115
116-
Client["Client"] -->|HTTP/StreamableHTTP| Proxy
117-
Proxy -->|HTTP/StreamableHTTP| MCP
116+
Client["Client"] -->|HTTP/Streamable HTTP| Proxy
117+
Proxy -->|HTTP/Streamable HTTP| MCP
118118
MCPService --> MCPPod
119119
```
120120

@@ -180,7 +180,7 @@ When you apply an `MCPServer` resource, here's what happens:
180180
4. The proxy creates the actual `MCPServer` pod containing your specified
181181
container image
182182
5. For STDIO transport, the proxy attaches directly to the pod; for SSE and
183-
StreamableHTTP transport, a headless service is created for direct pod
183+
Streamable HTTP transport, a headless service is created for direct pod
184184
communication
185185
6. Clients can now connect through the service → proxy → MCP server chain to use
186186
the tools and resources (note: external clients will need an ingress

0 commit comments

Comments
 (0)