[model-gateway][doc] Update transport terminology to protocol in README.md (#13872)

Co-authored-by: Simo Lin <linsimo.mark@gmail.com>
This commit is contained in:
Wenyi Xu
2025-11-26 11:44:59 -08:00
committed by GitHub
co-authored by Simo Lin
parent 69a03bc3f7
commit 67c8c86722
+5 -5
View File
@@ -246,12 +246,12 @@ servers:
- name: "github" - name: "github"
url: "https://api.github.com/mcp" url: "https://api.github.com/mcp"
token: "ghp_xxxxx" token: "ghp_xxxxx"
transport: "sse" protocol: "sse"
required: false required: false
- name: "custom-tools" - name: "custom-tools"
url: "https://tools.example.com/mcp" url: "https://tools.example.com/mcp"
transport: "streamable" protocol: "streamable"
required: true required: true
pool: pool:
@@ -276,7 +276,7 @@ inventory:
- `command` + `args`: For STDIO transport (local process execution) - `command` + `args`: For STDIO transport (local process execution)
- `url`: For SSE or Streamable transports (HTTP/HTTPS endpoints) - `url`: For SSE or Streamable transports (HTTP/HTTPS endpoints)
- `token`: Optional authentication token for HTTP-based transports - `token`: Optional authentication token for HTTP-based transports
- `transport`: Protocol type (`"sse"` or `"streamable"`; STDIO is inferred from `command`) - `protocol`: Protocol type (`"sse"` or `"streamable"`; STDIO is inferred from `command`)
- `required`: If `true`, router fails to start if server is unreachable (default: `false`) - `required`: If `true`, router fails to start if server is unreachable (default: `false`)
- `envs`: Environment variables for STDIO processes (optional) - `envs`: Environment variables for STDIO processes (optional)
- `proxy`: Per-server proxy override (set to `null` to bypass global proxy) - `proxy`: Per-server proxy override (set to `null` to bypass global proxy)
@@ -312,14 +312,14 @@ envs:
name: "remote-sse" name: "remote-sse"
url: "https://mcp.example.com/events" url: "https://mcp.example.com/events"
token: "bearer-token" token: "bearer-token"
transport: "sse" protocol: "sse"
``` ```
**Streamable** (Bidirectional Streaming): **Streamable** (Bidirectional Streaming):
```yaml ```yaml
name: "streaming-tools" name: "streaming-tools"
url: "https://mcp.example.com/stream" url: "https://mcp.example.com/stream"
transport: "streamable" protocol: "streamable"
required: true required: true
``` ```