Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/toolhive/reference/cli/thv_proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@ thv proxy [flags] SERVER_NAME
--remote-auth-client-secret string OAuth client secret for remote server authentication (optional for PKCE)
--remote-auth-client-secret-file string Path to file containing OAuth client secret (alternative to --remote-auth-client-secret)
--remote-auth-issuer string OAuth/OIDC issuer URL for remote server authentication (e.g., https://accounts.google.com)
--remote-auth-resource string OAuth 2.0 resource indicator (RFC 8707)
--remote-auth-scopes strings OAuth scopes to request for remote server authentication (defaults: OIDC uses 'openid,profile,email')
--remote-auth-skip-browser Skip opening browser for remote server OAuth flow
--remote-auth-timeout duration Timeout for OAuth authentication flow (e.g., 30s, 1m, 2m30s) (default 30s)
Expand Down
3 changes: 2 additions & 1 deletion docs/toolhive/reference/cli/thv_run.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ thv run [flags] SERVER_OR_IMAGE_OR_PROTOCOL [-- ARGS...]
--otel-tracing-enabled Enable distributed tracing (when OTLP endpoint is configured) (default true)
--permission-profile string Permission profile to use (none, network, or path to JSON file)
--print-resolved-overlays Debug: show resolved container paths for tmpfs overlays
--proxy-mode string Proxy mode for stdio transport (sse or streamable-http) (default "sse")
--proxy-mode string Proxy mode for stdio (streamable-http or sse) (default "streamable-http")
--proxy-port int Port for the HTTP proxy to listen on (host port)
--remote-auth Enable OAuth/OIDC authentication to remote MCP server
--remote-auth-authorize-url string OAuth authorization endpoint URL (alternative to --remote-auth-issuer for non-OIDC OAuth)
Expand All @@ -135,6 +135,7 @@ thv run [flags] SERVER_OR_IMAGE_OR_PROTOCOL [-- ARGS...]
--remote-auth-client-secret string OAuth client secret for remote server authentication (optional for PKCE)
--remote-auth-client-secret-file string Path to file containing OAuth client secret (alternative to --remote-auth-client-secret)
--remote-auth-issuer string OAuth/OIDC issuer URL for remote server authentication (e.g., https://accounts.google.com)
--remote-auth-resource string OAuth 2.0 resource indicator (RFC 8707)
--remote-auth-scopes strings OAuth scopes to request for remote server authentication (defaults: OIDC uses 'openid,profile,email')
--remote-auth-skip-browser Skip opening browser for remote server OAuth flow
--remote-auth-timeout duration Timeout for OAuth authentication flow (e.g., 30s, 1m, 2m30s) (default 30s)
Expand Down
15 changes: 13 additions & 2 deletions static/api-specs/toolhive-api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -542,6 +542,9 @@ components:
OAuthParams contains additional OAuth parameters to include in the authorization request
These are server-specific parameters like "prompt", "response_mode", etc.
type: object
resource:
description: Resource is the OAuth 2.0 resource indicator (RFC 8707)
type: string
scopes:
description: |-
Scopes are the OAuth scopes to request
Expand Down Expand Up @@ -687,7 +690,7 @@ components:
predicate_type:
type: string
type: object
runner.RemoteAuthConfig:
remote.Config:
description: RemoteAuthConfig contains OAuth configuration for remote MCP servers
properties:
authorize_url:
Expand Down Expand Up @@ -720,6 +723,9 @@ components:
type: string
description: OAuth parameters for server-specific customization
type: object
resource:
description: Resource is the OAuth 2.0 resource indicator (RFC 8707).
type: string
scopes:
items:
type: string
Expand Down Expand Up @@ -827,7 +833,7 @@ components:
proxy_mode:
$ref: '#/components/schemas/types.ProxyMode'
remote_auth_config:
$ref: '#/components/schemas/runner.RemoteAuthConfig'
$ref: '#/components/schemas/remote.Config'
remote_url:
description: RemoteURL is the URL of the remote MCP server (if running remotely)
type: string
Expand Down Expand Up @@ -910,6 +916,7 @@ components:
- WorkloadStatusUnhealthy
- WorkloadStatusRemoving
- WorkloadStatusUnknown
- WorkloadStatusUnauthenticated
secrets.SecretParameter:
properties:
name:
Expand Down Expand Up @@ -1460,6 +1467,9 @@ components:
type: string
description: Additional OAuth parameters for server-specific customization
type: object
resource:
description: OAuth 2.0 resource indicator (RFC 8707)
type: string
scopes:
description: OAuth scopes to request
items:
Expand Down Expand Up @@ -1650,6 +1660,7 @@ components:
- WorkloadStatusUnhealthy
- WorkloadStatusRemoving
- WorkloadStatusUnknown
- WorkloadStatusUnauthenticated
type: object
externalDocs:
description: ""
Expand Down