Skip to content

Commit 3da127e

Browse files
Update ToolHive reference docs for v0.1.3 (#40)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 803e3c8 commit 3da127e

File tree

4 files changed

+19
-9
lines changed

4 files changed

+19
-9
lines changed

docs/toolhive/reference/cli/thv_proxy.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ thv proxy [flags] SERVER_NAME
6969
--oidc-client-id string OIDC client ID
7070
--oidc-issuer string OIDC issuer URL (e.g., https://accounts.google.com)
7171
--oidc-jwks-url string URL to fetch the JWKS from
72+
--oidc-skip-opaque-token-validation Allow skipping validation of opaque tokens
7273
--port int Port for the HTTP proxy to listen on (host port)
7374
--remote-auth Enable OAuth authentication to remote MCP server
7475
--remote-auth-callback-port int Port for OAuth callback server during remote authentication (default: 8666) (default 8666)

docs/toolhive/reference/cli/thv_run.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ thv run [flags] SERVER_OR_IMAGE_OR_PROTOCOL [-- ARGS...]
6262
--oidc-client-id string OIDC client ID
6363
--oidc-issuer string OIDC issuer URL (e.g., https://accounts.google.com)
6464
--oidc-jwks-url string URL to fetch the JWKS from
65+
--oidc-skip-opaque-token-validation Allow skipping validation of opaque tokens
6566
--otel-enable-prometheus-metrics-path Enable Prometheus-style /metrics endpoint on the main transport port
6667
--otel-endpoint string OpenTelemetry OTLP endpoint URL (e.g., https://api.honeycomb.io)
6768
--otel-env-vars stringArray Environment variable names to include in OpenTelemetry spans (comma-separated: ENV1,ENV2)
@@ -71,6 +72,7 @@ thv run [flags] SERVER_OR_IMAGE_OR_PROTOCOL [-- ARGS...]
7172
--otel-service-name string OpenTelemetry service name (defaults to toolhive-mcp-proxy)
7273
--permission-profile string Permission profile to use (none, network, or path to JSON file) (default "network")
7374
--port int Port for the HTTP proxy to listen on (host port)
75+
--proxy-mode string Proxy mode for stdio transport (sse or streamable-http) (default "sse")
7476
--secret stringArray Specify a secret to be fetched from the secrets manager and set as an environment variable (format: NAME,target=TARGET)
7577
--target-host string Host to forward traffic to (only applicable to SSE or Streamable HTTP transport) (default "127.0.0.1")
7678
--target-port int Port for the container to expose (only applicable to SSE or Streamable HTTP transport)

docs/toolhive/reference/cli/thv_serve.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,16 @@ thv serve [flags]
2323
### Options
2424

2525
```
26-
-h, --help help for serve
27-
--host string Host address to bind the server to (default "127.0.0.1")
28-
--oidc-audience string Expected audience for the token
29-
--oidc-client-id string OIDC client ID
30-
--oidc-issuer string OIDC issuer URL (e.g., https://accounts.google.com)
31-
--oidc-jwks-url string URL to fetch the JWKS from
32-
--openapi Enable OpenAPI documentation endpoints (/api/openapi.json and /api/doc)
33-
--port int Port to bind the server to (default 8080)
34-
--socket string UNIX socket path to bind the server to (overrides host and port if provided)
26+
-h, --help help for serve
27+
--host string Host address to bind the server to (default "127.0.0.1")
28+
--oidc-audience string Expected audience for the token
29+
--oidc-client-id string OIDC client ID
30+
--oidc-issuer string OIDC issuer URL (e.g., https://accounts.google.com)
31+
--oidc-jwks-url string URL to fetch the JWKS from
32+
--oidc-skip-opaque-token-validation Allow skipping validation of opaque tokens
33+
--openapi Enable OpenAPI documentation endpoints (/api/openapi.json and /api/doc)
34+
--port int Port to bind the server to (default 8080)
35+
--socket string UNIX socket path to bind the server to (overrides host and port if provided)
3536
```
3637

3738
### Options inherited from parent commands

static/api-specs/toolhive-api.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -362,6 +362,9 @@ components:
362362
permission_profile:
363363
description: Permission profile to apply
364364
type: string
365+
proxy_mode:
366+
description: Proxy mode to use
367+
type: string
365368
secrets:
366369
description: Secret parameters to inject
367370
items:
@@ -470,6 +473,9 @@ components:
470473
v1.oidcOptions:
471474
description: OIDC configuration options
472475
properties:
476+
allow_opaque_tokens:
477+
description: Allow opaque tokens (non-JWT) for OIDC validation
478+
type: boolean
473479
audience:
474480
description: Expected audience
475481
type: string

0 commit comments

Comments
 (0)