Skip to content

Commit 9dbffcc

Browse files
Update ToolHive reference docs for v0.3.7 (#224)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 1051293 commit 9dbffcc

File tree

2 files changed

+27
-1
lines changed

2 files changed

+27
-1
lines changed

docs/toolhive/reference/cli/thv_run.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,7 @@ thv run [flags] SERVER_OR_IMAGE_OR_PROTOCOL [-- ARGS...]
134134
--tools stringArray Filter MCP server tools (comma-separated list of tool names)
135135
--tools-override string Path to a JSON file containing overrides for MCP server tools names and descriptions
136136
--transport string Transport mode (sse, streamable-http or stdio)
137+
--trust-proxy-headers Trust X-Forwarded-* headers from reverse proxies (X-Forwarded-Proto, X-Forwarded-Host, X-Forwarded-Port, X-Forwarded-Prefix)
137138
-v, --volume stringArray Mount a volume into the container (format: host-path:container-path[:ro])
138139
```
139140

static/api-specs/toolhive-api.yaml

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,10 @@ components:
195195
This is embedded in the URL.
196196
type: integer
197197
proxy_mode:
198-
description: ProxyMode is the proxy mode for stdio transport (sse or streamable-http).
198+
description: |-
199+
ProxyMode is the proxy mode that clients should use to connect.
200+
For stdio transports, this will be the proxy mode (sse or streamable-http).
201+
For direct transports (sse/streamable-http), this will be the same as TransportType.
199202
type: string
200203
remote:
201204
description: Remote indicates whether this is a remote workload (true) or
@@ -245,9 +248,21 @@ components:
245248
description: Whether to print resolved overlay paths for debugging
246249
type: boolean
247250
type: object
251+
permissions.InboundNetworkPermissions:
252+
description: Inbound defines inbound network permissions
253+
properties:
254+
allow_host:
255+
description: AllowHost is a list of allowed hosts for inbound connections
256+
items:
257+
type: string
258+
type: array
259+
uniqueItems: false
260+
type: object
248261
permissions.NetworkPermissions:
249262
description: Network defines network permissions
250263
properties:
264+
inbound:
265+
$ref: '#/components/schemas/permissions.InboundNetworkPermissions'
251266
outbound:
252267
$ref: '#/components/schemas/permissions.OutboundNetworkPermissions'
253268
type: object
@@ -842,6 +857,10 @@ components:
842857
- TransportTypeSSE
843858
- TransportTypeStreamableHTTP
844859
- TransportTypeInspector
860+
trust_proxy_headers:
861+
description: TrustProxyHeaders indicates whether to trust X-Forwarded-*
862+
headers from reverse proxies
863+
type: boolean
845864
volumes:
846865
description: |-
847866
Volumes are the directory mounts to pass to the container
@@ -1180,6 +1199,9 @@ components:
11801199
transport:
11811200
description: Transport configuration
11821201
type: string
1202+
trust_proxy_headers:
1203+
description: Whether to trust X-Forwarded-* headers from reverse proxies
1204+
type: boolean
11831205
url:
11841206
description: Remote server specific fields
11851207
type: string
@@ -1533,6 +1555,9 @@ components:
15331555
transport:
15341556
description: Transport configuration
15351557
type: string
1558+
trust_proxy_headers:
1559+
description: Whether to trust X-Forwarded-* headers from reverse proxies
1560+
type: boolean
15361561
url:
15371562
description: Remote server specific fields
15381563
type: string

0 commit comments

Comments
 (0)