Skip to content

Commit 4daa98f

Browse files
Update ToolHive reference docs for v0.2.5 (#93)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 914dadd commit 4daa98f

File tree

6 files changed

+233
-81
lines changed

6 files changed

+233
-81
lines changed

docs/toolhive/reference/cli/thv_build.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,10 @@ thv build [flags] PROTOCOL
4444
### Options
4545

4646
```
47-
-h, --help help for build
48-
-t, --tag string Name and optionally a tag in the 'name:tag' format for the built image
47+
--dry-run Generate Dockerfile without building (stdout output unless -o is set)
48+
-h, --help help for build
49+
-o, --output string Write the Dockerfile to the specified file instead of building
50+
-t, --tag string Name and optionally a tag in the 'name:tag' format for the built image
4951
```
5052

5153
### Options inherited from parent commands

docs/toolhive/reference/cli/thv_proxy.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,13 +48,22 @@ Basic transparent proxy:
4848

4949
thv proxy my-server --target-uri http://localhost:8080
5050

51-
Proxy with OAuth authentication to remote server:
51+
Proxy with OIDC authentication to remote server:
5252

5353
thv proxy my-server --target-uri https://api.example.com \
5454
--remote-auth --remote-auth-issuer https://auth.example.com \
5555
--remote-auth-client-id my-client-id \
5656
--remote-auth-client-secret-file /path/to/secret
5757

58+
Proxy with non-OIDC OAuth authentication to remote server:
59+
60+
thv proxy my-server --target-uri https://api.example.com \
61+
--remote-auth \
62+
--remote-auth-authorize-url https://auth.example.com/oauth/authorize \
63+
--remote-auth-token-url https://auth.example.com/oauth/token \
64+
--remote-auth-client-id my-client-id \
65+
--remote-auth-client-secret-file /path/to/secret
66+
5867
Proxy with OIDC protection for incoming requests:
5968

6069
thv proxy my-server --target-uri http://localhost:8080 \
@@ -77,19 +86,23 @@ thv proxy [flags] SERVER_NAME
7786
--host string Host for the HTTP proxy to listen on (IP or hostname) (default "127.0.0.1")
7887
--oidc-audience string Expected audience for the token
7988
--oidc-client-id string OIDC client ID
89+
--oidc-client-secret string OIDC client secret (optional, for introspection)
90+
--oidc-introspection-url string URL for token introspection endpoint
8091
--oidc-issuer string OIDC issuer URL (e.g., https://accounts.google.com)
8192
--oidc-jwks-url string URL to fetch the JWKS from
82-
--oidc-skip-opaque-token-validation Allow skipping validation of opaque tokens
8393
--port int Port for the HTTP proxy to listen on (host port)
8494
--remote-auth Enable OAuth authentication to remote MCP server
95+
--remote-auth-authorize-url string OAuth authorization endpoint URL (alternative to --remote-auth-issuer for non-OIDC OAuth)
8596
--remote-auth-callback-port int Port for OAuth callback server during remote authentication (default: 8666) (default 8666)
8697
--remote-auth-client-id string OAuth client ID for remote server authentication
8798
--remote-auth-client-secret string OAuth client secret for remote server authentication (optional for PKCE)
8899
--remote-auth-client-secret-file string Path to file containing OAuth client secret (alternative to --remote-auth-client-secret)
89100
--remote-auth-issuer string OAuth/OIDC issuer URL for remote server authentication (e.g., https://accounts.google.com)
90-
--remote-auth-scopes strings OAuth scopes to request for remote server authentication (default [openid,profile,email])
101+
--remote-auth-scopes strings OAuth scopes to request for remote server authentication (defaults: OIDC uses 'openid,profile,email')
91102
--remote-auth-skip-browser Skip opening browser for remote server OAuth flow
92103
--remote-auth-timeout duration Timeout for OAuth authentication flow (e.g., 30s, 1m, 2m30s) (default 30s)
104+
--remote-auth-token-url string OAuth token endpoint URL (alternative to --remote-auth-issuer for non-OIDC OAuth)
105+
--resource-url string Explicit resource URL for OAuth discovery endpoint (RFC 9728)
93106
--target-uri string URI for the target MCP server (e.g., http://localhost:8080) (required)
94107
```
95108

docs/toolhive/reference/cli/thv_restart.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,9 @@ thv restart [workload-name] [flags]
2424
### Options
2525

2626
```
27-
-a, --all Restart all MCP servers
28-
-h, --help help for restart
27+
-a, --all Restart all MCP servers
28+
-f, --foreground Run the restarted workload in foreground mode
29+
-h, --help help for restart
2930
```
3031

3132
### Options inherited from parent commands

docs/toolhive/reference/cli/thv_run.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,10 @@ thv run [flags] SERVER_OR_IMAGE_OR_PROTOCOL [-- ARGS...]
7878
--name string Name of the MCP server (auto-generated from image if not provided)
7979
--oidc-audience string Expected audience for the token
8080
--oidc-client-id string OIDC client ID
81+
--oidc-client-secret string OIDC client secret (optional, for introspection)
82+
--oidc-introspection-url string URL for token introspection endpoint
8183
--oidc-issuer string OIDC issuer URL (e.g., https://accounts.google.com)
8284
--oidc-jwks-url string URL to fetch the JWKS from
83-
--oidc-skip-opaque-token-validation Allow skipping validation of opaque tokens
8485
--otel-enable-prometheus-metrics-path Enable Prometheus-style /metrics endpoint on the main transport port
8586
--otel-endpoint string OpenTelemetry OTLP endpoint URL (e.g., https://api.honeycomb.io)
8687
--otel-env-vars stringArray Environment variable names to include in OpenTelemetry spans (comma-separated: ENV1,ENV2)
@@ -92,6 +93,7 @@ thv run [flags] SERVER_OR_IMAGE_OR_PROTOCOL [-- ARGS...]
9293
--print-resolved-overlays Debug: show resolved container paths for tmpfs overlays
9394
--proxy-mode string Proxy mode for stdio transport (sse or streamable-http) (default "sse")
9495
--proxy-port int Port for the HTTP proxy to listen on (host port)
96+
--resource-url string Explicit resource URL for OAuth discovery endpoint (RFC 9728)
9597
--secret stringArray Specify a secret to be fetched from the secrets manager and set as an environment variable (format: NAME,target=TARGET)
9698
--target-host string Host to forward traffic to (only applicable to SSE or Streamable HTTP transport) (default "127.0.0.1")
9799
--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: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -24,16 +24,17 @@ thv serve [flags]
2424
### Options
2525

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

3940
### Options inherited from parent commands

0 commit comments

Comments
 (0)