Skip to content

Commit 7178e03

Browse files
Update ToolHive reference docs for v0.13.0 (#635)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent de73f8a commit 7178e03

8 files changed

Lines changed: 168 additions & 109 deletions

File tree

docs/toolhive/reference/cli/thv_config.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,9 @@ The config command provides subcommands to manage application configuration sett
4141
* [thv config set-build-env](thv_config_set-build-env.md) - Set a build environment variable for protocol builds
4242
* [thv config set-ca-cert](thv_config_set-ca-cert.md) - Set the default CA certificate for container builds
4343
* [thv config set-registry](thv_config_set-registry.md) - Set the MCP server registry
44-
* [thv config set-registry-auth](thv_config_set-registry-auth.md) - Configure OAuth/OIDC authentication for the registry
4544
* [thv config unset-build-auth-file](thv_config_unset-build-auth-file.md) - Remove build auth file(s)
4645
* [thv config unset-build-env](thv_config_unset-build-env.md) - Remove build environment variable(s)
4746
* [thv config unset-ca-cert](thv_config_unset-ca-cert.md) - Remove the configured CA certificate
4847
* [thv config unset-registry](thv_config_unset-registry.md) - Remove the configured registry
49-
* [thv config unset-registry-auth](thv_config_unset-registry-auth.md) - Remove registry authentication configuration
5048
* [thv config usage-metrics](thv_config_usage-metrics.md) - Enable or disable anonymous usage metrics
5149

docs/toolhive/reference/cli/thv_config_set-registry-auth.md

Lines changed: 0 additions & 52 deletions
This file was deleted.

docs/toolhive/reference/cli/thv_config_set-registry.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,16 @@ The command automatically detects the registry type:
2121
- Other URLs are treated as MCP Registry API endpoints (v0.1 spec)
2222
- Local paths are treated as local registry files
2323

24+
Any previously configured registry authentication is cleared when this command is run.
25+
To configure OIDC authentication, provide --issuer and --client-id flags.
26+
2427
Examples:
2528
thv config set-registry https://example.com/registry.json # Static remote file
2629
thv config set-registry https://registry.example.com # API endpoint
2730
thv config set-registry /path/to/local-registry.json # Local file path
2831
thv config set-registry file:///path/to/local-registry.json # Explicit file URL
32+
thv config set-registry https://registry.example.com \
33+
--issuer https://auth.company.com --client-id toolhive-cli # With OAuth auth
2934

3035
```
3136
thv config set-registry <url-or-path> [flags]
@@ -35,7 +40,11 @@ thv config set-registry <url-or-path> [flags]
3540

3641
```
3742
-p, --allow-private-ip Allow setting the registry URL or API endpoint, even if it references a private IP address (default false)
43+
--audience string OAuth audience parameter for registry authentication
44+
--client-id string OAuth client ID for registry authentication
3845
-h, --help help for set-registry
46+
--issuer string OIDC issuer URL for registry authentication
47+
--scopes strings OAuth scopes for registry authentication (default [openid,offline_access])
3948
```
4049

4150
### Options inherited from parent commands

docs/toolhive/reference/cli/thv_config_unset-registry-auth.md

Lines changed: 0 additions & 39 deletions
This file was deleted.

docs/toolhive/reference/cli/thv_registry_login.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,12 @@ thv registry login [flags]
3232
### Options
3333

3434
```
35-
--audience string OAuth audience (optional)
36-
--client-id string OAuth client ID to save if OAuth is not configured
35+
--audience string OAuth audience parameter for registry authentication (optional)
36+
--client-id string OAuth client ID for registry authentication
3737
-h, --help help for login
38-
--issuer string OIDC issuer URL to save if OAuth is not configured
39-
--registry string Registry URL to save if not already configured
40-
--scopes strings OAuth scopes (defaults to openid,offline_access)
38+
--issuer string OIDC issuer URL for registry authentication
39+
--registry string Registry URL
40+
--scopes strings OAuth scopes for registry authentication (defaults to openid,offline_access)
4141
```
4242

4343
### Options inherited from parent commands

docs/toolhive/reference/cli/thv_run.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,7 @@ thv run [flags] SERVER_OR_IMAGE_OR_PROTOCOL [-- ARGS...]
155155
--print-resolved-overlays Debug: show resolved container paths for tmpfs overlays (default false)
156156
--proxy-mode string Proxy mode for stdio (streamable-http or sse (deprecated, will be removed)) (default "streamable-http")
157157
--proxy-port int Port for the HTTP proxy to listen on (host port)
158+
-p, --publish stringArray Publish a container's port(s) to the host (format: hostPort:containerPort)
158159
--remote-auth Enable OAuth/OIDC authentication to remote MCP server (default false)
159160
--remote-auth-authorize-url string OAuth authorization endpoint URL (alternative to --remote-auth-issuer for non-OIDC OAuth)
160161
--remote-auth-bearer-token string Bearer token for remote server authentication (alternative to OAuth)
@@ -172,7 +173,7 @@ thv run [flags] SERVER_OR_IMAGE_OR_PROTOCOL [-- ARGS...]
172173
--remote-forward-headers stringArray Headers to inject into requests to remote MCP server (format: Name=Value, can be repeated)
173174
--remote-forward-headers-secret stringArray Headers with secret values from ToolHive secrets manager (format: Name=secret-name, can be repeated)
174175
--resource-url string Explicit resource URL for OAuth discovery endpoint (RFC 9728)
175-
--runtime-add-package stringArray Add additional packages to install in the builder stage (can be repeated)
176+
--runtime-add-package stringArray Add additional packages to install in the builder and runtime stages (can be repeated)
176177
--runtime-image string Override the default base image for protocol schemes (e.g., golang:1.24-alpine, node:20-alpine, python:3.11-slim)
177178
--secret stringArray Specify a secret to be fetched from the secrets manager and set as an environment variable (format: NAME,target=TARGET)
178179
--target-host string Host to forward traffic to (only applicable to SSE or Streamable HTTP transport) (default "127.0.0.1")

0 commit comments

Comments
 (0)