Skip to content

Commit eb1a48e

Browse files
github-actions[bot]github-actions[bot]
authored
Update ToolHive reference docs for v0.2.1
1 parent 4fcbaf0 commit eb1a48e

File tree

12 files changed

+486
-15
lines changed

12 files changed

+486
-15
lines changed

‎docs/toolhive/reference/cli/thv.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ thv [flags]
3535

3636
* [thv client](thv_client.md) - Manage MCP clients
3737
* [thv config](thv_config.md) - Manage application configuration
38+
* [thv export](thv_export.md) - Export a workload's run configuration to a file
3839
* [thv inspector](thv_inspector.md) - Launches the MCP Inspector UI and connects it to the specified MCP server
3940
* [thv list](thv_list.md) - List running MCP servers
4041
* [thv logs](thv_logs.md) - Output the logs of an MCP server or manage log files
@@ -44,6 +45,8 @@ thv [flags]
4445
* [thv restart](thv_restart.md) - Restart a tooling server
4546
* [thv rm](thv_rm.md) - Remove an MCP server
4647
* [thv run](thv_run.md) - Run an MCP server
48+
* [thv runtime](thv_runtime.md) - Commands related to the container runtime
49+
* [thv runtime](thv_runtime.md) - Commands related to the container runtime
4750
* [thv search](thv_search.md) - Search for MCP servers
4851
* [thv secret](thv_secret.md) - Manage secrets
4952
* [thv serve](thv_serve.md) - Start the ToolHive API server

‎docs/toolhive/reference/cli/thv_client_register.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ Valid clients are:
2121
- roo-code: Roo Code extension for VS Code
2222
- vscode: Visual Studio Code
2323
- vscode-insider: Visual Studio Code Insiders edition
24+
- windsurf: Windsurf IDE
25+
- windsurf-jetbrains: Windsurf for JetBrains IDEs
2426

2527
```
2628
thv client register [client] [flags]

‎docs/toolhive/reference/cli/thv_client_remove.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ Valid clients are:
2121
- roo-code: Roo Code extension for VS Code
2222
- vscode: Visual Studio Code
2323
- vscode-insider: Visual Studio Code Insiders edition
24+
- windsurf: Windsurf IDE
25+
- windsurf-jetbrains: Windsurf for JetBrains IDEs
2426

2527
```
2628
thv client remove [client] [flags]

‎docs/toolhive/reference/cli/thv_export.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: thv export
3+
hide_title: true
4+
description: Reference for ToolHive CLI command `thv export`
5+
last_update:
6+
author: autogenerated
7+
slug: thv_export
8+
---
9+
10+
## thv export
11+
12+
Export a workload's run configuration to a file
13+
14+
### Synopsis
15+
16+
Export a workload's run configuration to a file for sharing or backup.
17+
18+
The exported configuration can be used with 'thv run --from-config <path>' to recreate
19+
the same workload with identical settings.
20+
21+
Examples:
22+
# Export a workload configuration to a file
23+
thv export my-server ./my-server-config.json
24+
25+
# Export to a specific directory
26+
thv export github-mcp /tmp/configs/github-config.json
27+
28+
```
29+
thv export <workload name> <path> [flags]
30+
```
31+
32+
### Options
33+
34+
```
35+
-h, --help help for export
36+
```
37+
38+
### Options inherited from parent commands
39+
40+
```
41+
--debug Enable debug mode
42+
```
43+
44+
### SEE ALSO
45+
46+
* [thv](thv.md) - ToolHive (thv) is a lightweight, secure, and fast manager for MCP servers
47+

‎docs/toolhive/reference/cli/thv_mcp_list.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ thv mcp list [tools|resources|prompts] [flags]
2626
-h, --help help for list
2727
--server string MCP server URL (required)
2828
--timeout duration Connection timeout (default 30s)
29+
--transport string Transport type (auto, sse, streamable-http) (default "auto")
2930
```
3031

3132
### Options inherited from parent commands

‎docs/toolhive/reference/cli/thv_mcp_list_prompts.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ thv mcp list prompts [flags]
2626
-h, --help help for prompts
2727
--server string MCP server URL (required)
2828
--timeout duration Connection timeout (default 30s)
29+
--transport string Transport type (auto, sse, streamable-http) (default "auto")
2930
```
3031

3132
### Options inherited from parent commands

‎docs/toolhive/reference/cli/thv_mcp_list_resources.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ thv mcp list resources [flags]
2626
-h, --help help for resources
2727
--server string MCP server URL (required)
2828
--timeout duration Connection timeout (default 30s)
29+
--transport string Transport type (auto, sse, streamable-http) (default "auto")
2930
```
3031

3132
### Options inherited from parent commands

‎docs/toolhive/reference/cli/thv_mcp_list_tools.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ thv mcp list tools [flags]
2626
-h, --help help for tools
2727
--server string MCP server URL (required)
2828
--timeout duration Connection timeout (default 30s)
29+
--transport string Transport type (auto, sse, streamable-http) (default "auto")
2930
```
3031

3132
### Options inherited from parent commands

‎docs/toolhive/reference/cli/thv_run.md‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Run an MCP server
1515

1616
Run an MCP server with the specified name, image, or protocol scheme.
1717

18-
ToolHive supports three ways to run an MCP server:
18+
ToolHive supports four ways to run an MCP server:
1919

2020
1. From the registry:
2121
$ thv run server-name [-- args...]
@@ -36,6 +36,10 @@ ToolHive supports three ways to run an MCP server:
3636
or go (Golang). For Go, you can also specify local paths starting
3737
with './' or '../' to build and run local Go projects.
3838

39+
4. From an exported configuration:
40+
$ thv run --from-config <path>
41+
Runs an MCP server using a previously exported configuration file.
42+
3943
The container will be started with the specified transport mode and
4044
permission profile. Additional configuration can be provided via flags.
4145

@@ -52,8 +56,10 @@ thv run [flags] SERVER_OR_IMAGE_OR_PROTOCOL [-- ARGS...]
5256
--enable-audit Enable audit logging with default configuration
5357
-e, --env stringArray Environment variables to pass to the MCP server (format: KEY=VALUE)
5458
-f, --foreground Run in foreground mode (block until container exits)
59+
--from-config string Load configuration from exported file
5560
-h, --help help for run
5661
--host string Host for the HTTP proxy to listen on (IP or hostname) (default "127.0.0.1")
62+
--ignore-globally Load global ignore patterns from ~/.config/toolhive/thvignore (default true)
5763
--image-verification string Set image verification mode (warn, enabled, disabled) (default "warn")
5864
--isolate-network Isolate the container network from the host (default: false)
5965
--jwks-allow-private-ip Allow JWKS/OIDC endpoints on private IP addresses (use with caution)
@@ -73,12 +79,14 @@ thv run [flags] SERVER_OR_IMAGE_OR_PROTOCOL [-- ARGS...]
7379
--otel-sampling-rate float OpenTelemetry trace sampling rate (0.0-1.0) (default 0.1)
7480
--otel-service-name string OpenTelemetry service name (defaults to toolhive-mcp-proxy)
7581
--permission-profile string Permission profile to use (none, network, or path to JSON file)
82+
--print-resolved-overlays Debug: show resolved container paths for tmpfs overlays
7683
--proxy-mode string Proxy mode for stdio transport (sse or streamable-http) (default "sse")
7784
--proxy-port int Port for the HTTP proxy to listen on (host port)
7885
--secret stringArray Specify a secret to be fetched from the secrets manager and set as an environment variable (format: NAME,target=TARGET)
7986
--target-host string Host to forward traffic to (only applicable to SSE or Streamable HTTP transport) (default "127.0.0.1")
8087
--target-port int Port for the container to expose (only applicable to SSE or Streamable HTTP transport)
8188
--thv-ca-bundle string Path to CA certificate bundle for ToolHive HTTP operations (JWKS, OIDC discovery, etc.)
89+
--tools stringArray Filter MCP server tools (comma-separated list of tool names)
8290
--transport string Transport mode (sse, streamable-http or stdio)
8391
-v, --volume stringArray Mount a volume into the container (format: host-path:container-path[:ro])
8492
```

‎docs/toolhive/reference/cli/thv_runtime.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: thv runtime
3+
hide_title: true
4+
description: Reference for ToolHive CLI command `thv runtime`
5+
last_update:
6+
author: autogenerated
7+
slug: thv_runtime
8+
---
9+
10+
## thv runtime
11+
12+
Commands related to the container runtime
13+
14+
### Options
15+
16+
```
17+
-h, --help help for runtime
18+
```
19+
20+
### Options inherited from parent commands
21+
22+
```
23+
--debug Enable debug mode
24+
```
25+
26+
### SEE ALSO
27+
28+
* [thv](thv.md) - ToolHive (thv) is a lightweight, secure, and fast manager for MCP servers
29+
* [thv runtime check](thv_runtime_check.md) - Ping the container runtime
30+
* [thv runtime check](thv_runtime_check.md) - Ping the container runtime
31+

0 commit comments

Comments
 (0)