Skip to content

Update ToolHive reference docs for v0.2.1 #78

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 29, 2025
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
5 changes: 5 additions & 0 deletions docs/toolhive/reference/cli/thv.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: Reference for ToolHive CLI command `thv`
last_update:
author: autogenerated
slug: thv
mdx:
format: md
---

## thv
Expand Down Expand Up @@ -35,6 +37,7 @@ thv [flags]

* [thv client](thv_client.md) - Manage MCP clients
* [thv config](thv_config.md) - Manage application configuration
* [thv export](thv_export.md) - Export a workload's run configuration to a file
* [thv inspector](thv_inspector.md) - Launches the MCP Inspector UI and connects it to the specified MCP server
* [thv list](thv_list.md) - List running MCP servers
* [thv logs](thv_logs.md) - Output the logs of an MCP server or manage log files
Expand All @@ -44,6 +47,8 @@ thv [flags]
* [thv restart](thv_restart.md) - Restart a tooling server
* [thv rm](thv_rm.md) - Remove an MCP server
* [thv run](thv_run.md) - Run an MCP server
* [thv runtime](thv_runtime.md) - Commands related to the container runtime
* [thv runtime](thv_runtime.md) - Commands related to the container runtime
* [thv search](thv_search.md) - Search for MCP servers
* [thv secret](thv_secret.md) - Manage secrets
* [thv serve](thv_serve.md) - Start the ToolHive API server
Expand Down
2 changes: 2 additions & 0 deletions docs/toolhive/reference/cli/thv_client.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: Reference for ToolHive CLI command `thv client`
last_update:
author: autogenerated
slug: thv_client
mdx:
format: md
---

## thv client
Expand Down
2 changes: 2 additions & 0 deletions docs/toolhive/reference/cli/thv_client_list-registered.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: Reference for ToolHive CLI command `thv client list-registered`
last_update:
author: autogenerated
slug: thv_client_list-registered
mdx:
format: md
---

## thv client list-registered
Expand Down
7 changes: 6 additions & 1 deletion docs/toolhive/reference/cli/thv_client_register.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: Reference for ToolHive CLI command `thv client register`
last_update:
author: autogenerated
slug: thv_client_register
mdx:
format: md
---

## thv client register
Expand All @@ -14,13 +16,16 @@ Register a client for MCP server configuration
### Synopsis

Register a client for MCP server configuration.
Valid clients are:

Valid clients:
- claude-code: Claude Code CLI
- cline: Cline extension for VS Code
- cursor: Cursor editor
- roo-code: Roo Code extension for VS Code
- vscode: Visual Studio Code
- vscode-insider: Visual Studio Code Insiders edition
- windsurf: Windsurf IDE
- windsurf-jetbrains: Windsurf for JetBrains IDEs

```
thv client register [client] [flags]
Expand Down
7 changes: 6 additions & 1 deletion docs/toolhive/reference/cli/thv_client_remove.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: Reference for ToolHive CLI command `thv client remove`
last_update:
author: autogenerated
slug: thv_client_remove
mdx:
format: md
---

## thv client remove
Expand All @@ -14,13 +16,16 @@ Remove a client from MCP server configuration
### Synopsis

Remove a client from MCP server configuration.
Valid clients are:

Valid clients:
- claude-code: Claude Code CLI
- cline: Cline extension for VS Code
- cursor: Cursor editor
- roo-code: Roo Code extension for VS Code
- vscode: Visual Studio Code
- vscode-insider: Visual Studio Code Insiders edition
- windsurf: Windsurf IDE
- windsurf-jetbrains: Windsurf for JetBrains IDEs

```
thv client remove [client] [flags]
Expand Down
2 changes: 2 additions & 0 deletions docs/toolhive/reference/cli/thv_client_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: Reference for ToolHive CLI command `thv client setup`
last_update:
author: autogenerated
slug: thv_client_setup
mdx:
format: md
---

## thv client setup
Expand Down
2 changes: 2 additions & 0 deletions docs/toolhive/reference/cli/thv_client_status.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: Reference for ToolHive CLI command `thv client status`
last_update:
author: autogenerated
slug: thv_client_status
mdx:
format: md
---

## thv client status
Expand Down
2 changes: 2 additions & 0 deletions docs/toolhive/reference/cli/thv_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: Reference for ToolHive CLI command `thv config`
last_update:
author: autogenerated
slug: thv_config
mdx:
format: md
---

## thv config
Expand Down
2 changes: 2 additions & 0 deletions docs/toolhive/reference/cli/thv_config_get-ca-cert.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: Reference for ToolHive CLI command `thv config get-ca-cert`
last_update:
author: autogenerated
slug: thv_config_get-ca-cert
mdx:
format: md
---

## thv config get-ca-cert
Expand Down
2 changes: 2 additions & 0 deletions docs/toolhive/reference/cli/thv_config_get-registry-url.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: Reference for ToolHive CLI command `thv config get-registry-url`
last_update:
author: autogenerated
slug: thv_config_get-registry-url
mdx:
format: md
---

## thv config get-registry-url
Expand Down
2 changes: 2 additions & 0 deletions docs/toolhive/reference/cli/thv_config_otel.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: Reference for ToolHive CLI command `thv config otel`
last_update:
author: autogenerated
slug: thv_config_otel
mdx:
format: md
---

## thv config otel
Expand Down
2 changes: 2 additions & 0 deletions docs/toolhive/reference/cli/thv_config_otel_get-endpoint.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: Reference for ToolHive CLI command `thv config otel get-endpoint`
last_update:
author: autogenerated
slug: thv_config_otel_get-endpoint
mdx:
format: md
---

## thv config otel get-endpoint
Expand Down
2 changes: 2 additions & 0 deletions docs/toolhive/reference/cli/thv_config_otel_get-env-vars.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: Reference for ToolHive CLI command `thv config otel get-env-vars`
last_update:
author: autogenerated
slug: thv_config_otel_get-env-vars
mdx:
format: md
---

## thv config otel get-env-vars
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: Reference for ToolHive CLI command `thv config otel get-sampling-ra
last_update:
author: autogenerated
slug: thv_config_otel_get-sampling-rate
mdx:
format: md
---

## thv config otel get-sampling-rate
Expand Down
6 changes: 5 additions & 1 deletion docs/toolhive/reference/cli/thv_config_otel_set-endpoint.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: Reference for ToolHive CLI command `thv config otel set-endpoint`
last_update:
author: autogenerated
slug: thv_config_otel_set-endpoint
mdx:
format: md
---

## thv config otel set-endpoint
Expand All @@ -14,10 +16,12 @@ Set the OpenTelemetry endpoint URL
### Synopsis

Set the OpenTelemetry OTLP endpoint URL for tracing and metrics.

This endpoint will be used by default when running MCP servers unless overridden by the --otel-endpoint flag.

Example:
thv config otel set-endpoint https://api.honeycomb.io

thv config otel set-endpoint https://api.honeycomb.io

```
thv config otel set-endpoint <endpoint> [flags]
Expand Down
6 changes: 5 additions & 1 deletion docs/toolhive/reference/cli/thv_config_otel_set-env-vars.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: Reference for ToolHive CLI command `thv config otel set-env-vars`
last_update:
author: autogenerated
slug: thv_config_otel_set-env-vars
mdx:
format: md
---

## thv config otel set-env-vars
Expand All @@ -14,10 +16,12 @@ Set the OpenTelemetry environment variables
### Synopsis

Set the list of environment variable names to include in OpenTelemetry spans.

These environment variables will be used by default when running MCP servers unless overridden by the --otel-env-vars flag.

Example:
thv config otel set-env-vars USER,HOME,PATH

thv config otel set-env-vars USER,HOME,PATH

```
thv config otel set-env-vars <var1,var2,...> [flags]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: Reference for ToolHive CLI command `thv config otel set-sampling-ra
last_update:
author: autogenerated
slug: thv_config_otel_set-sampling-rate
mdx:
format: md
---

## thv config otel set-sampling-rate
Expand All @@ -14,10 +16,12 @@ Set the OpenTelemetry sampling rate
### Synopsis

Set the OpenTelemetry trace sampling rate (between 0.0 and 1.0).

This sampling rate will be used by default when running MCP servers unless overridden by the --otel-sampling-rate flag.

Example:
thv config otel set-sampling-rate 0.1

thv config otel set-sampling-rate 0.1

```
thv config otel set-sampling-rate <rate> [flags]
Expand Down
2 changes: 2 additions & 0 deletions docs/toolhive/reference/cli/thv_config_otel_unset-endpoint.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: Reference for ToolHive CLI command `thv config otel unset-endpoint`
last_update:
author: autogenerated
slug: thv_config_otel_unset-endpoint
mdx:
format: md
---

## thv config otel unset-endpoint
Expand Down
2 changes: 2 additions & 0 deletions docs/toolhive/reference/cli/thv_config_otel_unset-env-vars.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: Reference for ToolHive CLI command `thv config otel unset-env-vars`
last_update:
author: autogenerated
slug: thv_config_otel_unset-env-vars
mdx:
format: md
---

## thv config otel unset-env-vars
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: Reference for ToolHive CLI command `thv config otel unset-sampling-
last_update:
author: autogenerated
slug: thv_config_otel_unset-sampling-rate
mdx:
format: md
---

## thv config otel unset-sampling-rate
Expand Down
2 changes: 2 additions & 0 deletions docs/toolhive/reference/cli/thv_config_set-ca-cert.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: Reference for ToolHive CLI command `thv config set-ca-cert`
last_update:
author: autogenerated
slug: thv_config_set-ca-cert
mdx:
format: md
---

## thv config set-ca-cert
Expand Down
2 changes: 2 additions & 0 deletions docs/toolhive/reference/cli/thv_config_set-registry-url.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: Reference for ToolHive CLI command `thv config set-registry-url`
last_update:
author: autogenerated
slug: thv_config_set-registry-url
mdx:
format: md
---

## thv config set-registry-url
Expand Down
2 changes: 2 additions & 0 deletions docs/toolhive/reference/cli/thv_config_unset-ca-cert.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: Reference for ToolHive CLI command `thv config unset-ca-cert`
last_update:
author: autogenerated
slug: thv_config_unset-ca-cert
mdx:
format: md
---

## thv config unset-ca-cert
Expand Down
2 changes: 2 additions & 0 deletions docs/toolhive/reference/cli/thv_config_unset-registry-url.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: Reference for ToolHive CLI command `thv config unset-registry-url`
last_update:
author: autogenerated
slug: thv_config_unset-registry-url
mdx:
format: md
---

## thv config unset-registry-url
Expand Down
50 changes: 50 additions & 0 deletions docs/toolhive/reference/cli/thv_export.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
title: thv export
hide_title: true
description: Reference for ToolHive CLI command `thv export`
last_update:
author: autogenerated
slug: thv_export
mdx:
format: md
---

## thv export

Export a workload's run configuration to a file

### Synopsis

Export a workload's run configuration to a file for sharing or backup.

The exported configuration can be used with 'thv run --from-config <path>' to recreate
the same workload with identical settings.

Examples:

# Export a workload configuration to a file
thv export my-server ./my-server-config.json

# Export to a specific directory
thv export github-mcp /tmp/configs/github-config.json

```
thv export <workload name> <path> [flags]
```

### Options

```
-h, --help help for export
```

### Options inherited from parent commands

```
--debug Enable debug mode
```

### SEE ALSO

* [thv](thv.md) - ToolHive (thv) is a lightweight, secure, and fast manager for MCP servers

2 changes: 2 additions & 0 deletions docs/toolhive/reference/cli/thv_inspector.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: Reference for ToolHive CLI command `thv inspector`
last_update:
author: autogenerated
slug: thv_inspector
mdx:
format: md
---

## thv inspector
Expand Down
2 changes: 2 additions & 0 deletions docs/toolhive/reference/cli/thv_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: Reference for ToolHive CLI command `thv list`
last_update:
author: autogenerated
slug: thv_list
mdx:
format: md
---

## thv list
Expand Down
2 changes: 2 additions & 0 deletions docs/toolhive/reference/cli/thv_logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: Reference for ToolHive CLI command `thv logs`
last_update:
author: autogenerated
slug: thv_logs
mdx:
format: md
---

## thv logs
Expand Down
2 changes: 2 additions & 0 deletions docs/toolhive/reference/cli/thv_logs_prune.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: Reference for ToolHive CLI command `thv logs prune`
last_update:
author: autogenerated
slug: thv_logs_prune
mdx:
format: md
---

## thv logs prune
Expand Down
Loading