Skip to content

Commit 8b1c651

Browse files
Update ToolHive reference docs for v0.6.2 (#288)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent dea8537 commit 8b1c651

File tree

3 files changed

+16
-3
lines changed

3 files changed

+16
-3
lines changed

docs/toolhive/reference/cli/thv_proxy.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,7 @@ thv proxy [flags] SERVER_NAME
113113
--remote-auth-client-secret string OAuth client secret for remote server authentication (optional for PKCE)
114114
--remote-auth-client-secret-file string Path to file containing OAuth client secret (alternative to --remote-auth-client-secret)
115115
--remote-auth-issuer string OAuth/OIDC issuer URL for remote server authentication (e.g., https://accounts.google.com)
116+
--remote-auth-resource string OAuth 2.0 resource indicator (RFC 8707)
116117
--remote-auth-scopes strings OAuth scopes to request for remote server authentication (defaults: OIDC uses 'openid,profile,email')
117118
--remote-auth-skip-browser Skip opening browser for remote server OAuth flow
118119
--remote-auth-timeout duration Timeout for OAuth authentication flow (e.g., 30s, 1m, 2m30s) (default 30s)

docs/toolhive/reference/cli/thv_run.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ thv run [flags] SERVER_OR_IMAGE_OR_PROTOCOL [-- ARGS...]
126126
--otel-tracing-enabled Enable distributed tracing (when OTLP endpoint is configured) (default true)
127127
--permission-profile string Permission profile to use (none, network, or path to JSON file)
128128
--print-resolved-overlays Debug: show resolved container paths for tmpfs overlays
129-
--proxy-mode string Proxy mode for stdio transport (sse or streamable-http) (default "sse")
129+
--proxy-mode string Proxy mode for stdio (streamable-http or sse) (default "streamable-http")
130130
--proxy-port int Port for the HTTP proxy to listen on (host port)
131131
--remote-auth Enable OAuth/OIDC authentication to remote MCP server
132132
--remote-auth-authorize-url string OAuth authorization endpoint URL (alternative to --remote-auth-issuer for non-OIDC OAuth)
@@ -135,6 +135,7 @@ thv run [flags] SERVER_OR_IMAGE_OR_PROTOCOL [-- ARGS...]
135135
--remote-auth-client-secret string OAuth client secret for remote server authentication (optional for PKCE)
136136
--remote-auth-client-secret-file string Path to file containing OAuth client secret (alternative to --remote-auth-client-secret)
137137
--remote-auth-issuer string OAuth/OIDC issuer URL for remote server authentication (e.g., https://accounts.google.com)
138+
--remote-auth-resource string OAuth 2.0 resource indicator (RFC 8707)
138139
--remote-auth-scopes strings OAuth scopes to request for remote server authentication (defaults: OIDC uses 'openid,profile,email')
139140
--remote-auth-skip-browser Skip opening browser for remote server OAuth flow
140141
--remote-auth-timeout duration Timeout for OAuth authentication flow (e.g., 30s, 1m, 2m30s) (default 30s)

static/api-specs/toolhive-api.yaml

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -542,6 +542,9 @@ components:
542542
OAuthParams contains additional OAuth parameters to include in the authorization request
543543
These are server-specific parameters like "prompt", "response_mode", etc.
544544
type: object
545+
resource:
546+
description: Resource is the OAuth 2.0 resource indicator (RFC 8707)
547+
type: string
545548
scopes:
546549
description: |-
547550
Scopes are the OAuth scopes to request
@@ -687,7 +690,7 @@ components:
687690
predicate_type:
688691
type: string
689692
type: object
690-
runner.RemoteAuthConfig:
693+
remote.Config:
691694
description: RemoteAuthConfig contains OAuth configuration for remote MCP servers
692695
properties:
693696
authorize_url:
@@ -720,6 +723,9 @@ components:
720723
type: string
721724
description: OAuth parameters for server-specific customization
722725
type: object
726+
resource:
727+
description: Resource is the OAuth 2.0 resource indicator (RFC 8707).
728+
type: string
723729
scopes:
724730
items:
725731
type: string
@@ -827,7 +833,7 @@ components:
827833
proxy_mode:
828834
$ref: '#/components/schemas/types.ProxyMode'
829835
remote_auth_config:
830-
$ref: '#/components/schemas/runner.RemoteAuthConfig'
836+
$ref: '#/components/schemas/remote.Config'
831837
remote_url:
832838
description: RemoteURL is the URL of the remote MCP server (if running remotely)
833839
type: string
@@ -910,6 +916,7 @@ components:
910916
- WorkloadStatusUnhealthy
911917
- WorkloadStatusRemoving
912918
- WorkloadStatusUnknown
919+
- WorkloadStatusUnauthenticated
913920
secrets.SecretParameter:
914921
properties:
915922
name:
@@ -1460,6 +1467,9 @@ components:
14601467
type: string
14611468
description: Additional OAuth parameters for server-specific customization
14621469
type: object
1470+
resource:
1471+
description: OAuth 2.0 resource indicator (RFC 8707)
1472+
type: string
14631473
scopes:
14641474
description: OAuth scopes to request
14651475
items:
@@ -1650,6 +1660,7 @@ components:
16501660
- WorkloadStatusUnhealthy
16511661
- WorkloadStatusRemoving
16521662
- WorkloadStatusUnknown
1663+
- WorkloadStatusUnauthenticated
16531664
type: object
16541665
externalDocs:
16551666
description: ""

0 commit comments

Comments
 (0)