From 8132c1a16700a3fe05e4df07bd274d87a85fdfb0 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 5 Jan 2026 08:45:18 +0000 Subject: [PATCH 1/2] Update ToolHive reference docs for v0.6.16 --- docs/toolhive/reference/cli/thv.md | 2 +- docs/toolhive/reference/cli/thv_list.md | 16 +++++++++++++ docs/toolhive/reference/cli/thv_logs.md | 13 ++++++++++ docs/toolhive/reference/cli/thv_rm.md | 14 ++++++++++- docs/toolhive/reference/cli/thv_run.md | 24 +++++++++++++++++++ .../cli/{thv_restart.md => thv_start.md} | 17 ++++++------- docs/toolhive/reference/cli/thv_stop.md | 13 +++++++++- 7 files changed, 88 insertions(+), 11 deletions(-) rename docs/toolhive/reference/cli/{thv_restart.md => thv_start.md} (65%) diff --git a/docs/toolhive/reference/cli/thv.md b/docs/toolhive/reference/cli/thv.md index eb8ca4e3..f630f869 100644 --- a/docs/toolhive/reference/cli/thv.md +++ b/docs/toolhive/reference/cli/thv.md @@ -46,13 +46,13 @@ thv [flags] * [thv mcp](thv_mcp.md) - Interact with MCP servers for debugging * [thv proxy](thv_proxy.md) - Create a transparent proxy for an MCP server with authentication support * [thv registry](thv_registry.md) - Manage MCP server registry -* [thv restart](thv_restart.md) - Restart a tooling server * [thv rm](thv_rm.md) - Remove one or more MCP servers * [thv run](thv_run.md) - Run an MCP server * [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 +* [thv start](thv_start.md) - Start (resume) a tooling server * [thv stop](thv_stop.md) - Stop one or more MCP servers * [thv version](thv_version.md) - Show the version of ToolHive diff --git a/docs/toolhive/reference/cli/thv_list.md b/docs/toolhive/reference/cli/thv_list.md index b164a632..6c0b465e 100644 --- a/docs/toolhive/reference/cli/thv_list.md +++ b/docs/toolhive/reference/cli/thv_list.md @@ -17,6 +17,22 @@ List running MCP servers List all MCP servers managed by ToolHive, including their status and configuration. +Examples: + # List running MCP servers + thv list + + # List all MCP servers (including stopped) + thv list --all + + # List servers in JSON format + thv list --format json + + # List servers in a specific group + thv list --group production + + # List servers with specific labels + thv list --label env=dev --label team=backend + ``` thv list [flags] ``` diff --git a/docs/toolhive/reference/cli/thv_logs.md b/docs/toolhive/reference/cli/thv_logs.md index de1c5525..a055299a 100644 --- a/docs/toolhive/reference/cli/thv_logs.md +++ b/docs/toolhive/reference/cli/thv_logs.md @@ -20,6 +20,19 @@ Output the logs of an MCP server managed by ToolHive, or manage log files. By default, this command shows the logs from the MCP server container. Use --proxy to view the logs from the ToolHive proxy process instead. +Examples: + # View logs of an MCP server + thv logs filesystem + + # Follow logs in real-time + thv logs filesystem --follow + + # View proxy logs instead of container logs + thv logs filesystem --proxy + + # Clean up old log files + thv logs prune + ``` thv logs [workload-name|prune] [flags] ``` diff --git a/docs/toolhive/reference/cli/thv_rm.md b/docs/toolhive/reference/cli/thv_rm.md index 3ec7b59a..eeb7dc07 100644 --- a/docs/toolhive/reference/cli/thv_rm.md +++ b/docs/toolhive/reference/cli/thv_rm.md @@ -15,7 +15,19 @@ Remove one or more MCP servers ### Synopsis -Remove one or more MCP servers managed by ToolHive. +Remove one or more MCP servers managed by ToolHive. +Examples: + # Remove a single MCP server + thv rm filesystem + + # Remove multiple MCP servers + thv rm filesystem github slack + + # Remove all workloads + thv rm --all + + # Remove all workloads in a group + thv rm --group production ``` thv rm [workload-name...] [flags] diff --git a/docs/toolhive/reference/cli/thv_run.md b/docs/toolhive/reference/cli/thv_run.md index 99906dc7..0280ba4b 100644 --- a/docs/toolhive/reference/cli/thv_run.md +++ b/docs/toolhive/reference/cli/thv_run.md @@ -80,6 +80,30 @@ You can specify the network mode for the container using the --network flag: The --network flag accepts any Docker-compatible network mode. +Examples: + # Run a server from the registry + thv run filesystem + + # Run a server with custom arguments and toolsets + thv run github -- --toolsets repos + + # Run from a container image + thv run ghcr.io/github/github-mcp-server + + # Run using a protocol scheme (Python with uv) + thv run uvx://mcp-server-git + + # Run using npx (Node.js) + thv run npx://@modelcontextprotocol/server-everything + + # Run a server in a specific group + thv run filesystem --group production + +# Run a remote GitHub MCP server with authentication +thv run github-remote --remote-auth \ + --remote-auth-client-id \ + --remote-auth-client-secret + ``` thv run [flags] SERVER_OR_IMAGE_OR_PROTOCOL [-- ARGS...] ``` diff --git a/docs/toolhive/reference/cli/thv_restart.md b/docs/toolhive/reference/cli/thv_start.md similarity index 65% rename from docs/toolhive/reference/cli/thv_restart.md rename to docs/toolhive/reference/cli/thv_start.md index 2a9bfb5c..130ff352 100644 --- a/docs/toolhive/reference/cli/thv_restart.md +++ b/docs/toolhive/reference/cli/thv_start.md @@ -1,26 +1,27 @@ --- -title: thv restart +title: thv start hide_title: true -description: Reference for ToolHive CLI command `thv restart` +description: Reference for ToolHive CLI command `thv start` last_update: author: autogenerated -slug: thv_restart +slug: thv_start mdx: format: md --- -## thv restart +## thv start -Restart a tooling server +Start (resume) a tooling server ### Synopsis -Restart a running tooling server managed by ToolHive. +Start (or resume) a tooling server managed by ToolHive. If the server is not running, it will be started. +The alias "thv restart" is kept for backward compatibility. Supports both container-based and remote MCP servers. ``` -thv restart [workload-name] [flags] +thv start [workload-name] [flags] ``` ### Options @@ -29,7 +30,7 @@ thv restart [workload-name] [flags] -a, --all Restart all MCP servers -f, --foreground Run the restarted workload in foreground mode -g, --group string Restart all MCP servers in a specific group - -h, --help help for restart + -h, --help help for start ``` ### Options inherited from parent commands diff --git a/docs/toolhive/reference/cli/thv_stop.md b/docs/toolhive/reference/cli/thv_stop.md index 050f318c..3bb21124 100644 --- a/docs/toolhive/reference/cli/thv_stop.md +++ b/docs/toolhive/reference/cli/thv_stop.md @@ -15,7 +15,18 @@ Stop one or more MCP servers ### Synopsis -Stop one or more running MCP servers managed by ToolHive. +Stop one or more running MCP servers managed by ToolHive. Examples: + # Stop a single MCP server + thv stop filesystem + + # Stop multiple MCP servers + thv stop filesystem github slack + + # Stop all running MCP servers + thv stop --all + + # Stop all servers in a group + thv stop --group production ``` thv stop [workload-name...] [flags] From 4f72d8236dcdd3634fb295844216f06241228828 Mon Sep 17 00:00:00 2001 From: Eleftheria Stein-Kousathana Date: Mon, 5 Jan 2026 10:47:46 +0100 Subject: [PATCH 2/2] Fix references to thv restart --- docs/toolhive/guides-cli/manage-mcp-servers.mdx | 14 +++++++------- docs/toolhive/tutorials/quickstart-cli.mdx | 4 ++-- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/toolhive/guides-cli/manage-mcp-servers.mdx b/docs/toolhive/guides-cli/manage-mcp-servers.mdx index 2669cb30..35ab0aa9 100644 --- a/docs/toolhive/guides-cli/manage-mcp-servers.mdx +++ b/docs/toolhive/guides-cli/manage-mcp-servers.mdx @@ -94,10 +94,10 @@ Add the `--all` flag to stop all running servers. ### Restart a server -To restart a stopped MCP server and add it back to your configured clients: +To start a stopped MCP server and add it back to your configured clients: ```bash -thv restart +thv start ``` For remote servers, restarting will: @@ -106,10 +106,10 @@ For remote servers, restarting will: 2. Re-establish connection to the remote server 3. Re-authenticate with the remote server (triggers new OAuth flow) -Add the `--group` flag to restart all servers in a specific group: +Add the `--group` flag to start all servers in a specific group: ```bash -thv restart --group +thv start --group ``` ### Remove a server @@ -142,11 +142,11 @@ won't clean up the MCP server's entry in your configured clients. Use ### Remote server authentication Remote servers with OAuth authentication will automatically refresh tokens when -they expire during normal operation. However, restarting a remote server always +they expire during normal operation. However, starting a remote server always triggers a new OAuth authentication flow: ```bash -thv restart +thv start ``` This will always prompt for re-authentication, even if valid tokens exist. @@ -156,6 +156,6 @@ This will always prompt for re-authentication, even if valid tokens exist. - [`thv list` command reference](../reference/cli/thv_list.md) - [`thv logs` command reference](../reference/cli/thv_logs.md) - [`thv stop` command reference](../reference/cli/thv_stop.md) -- [`thv restart` command reference](../reference/cli/thv_restart.md) +- [`thv start` command reference](../reference/cli/thv_start.md) - [`thv rm` command reference](../reference/cli/thv_rm.md) - [Monitor with OpenTelemetry](../guides-cli/telemetry-and-metrics.mdx) diff --git a/docs/toolhive/tutorials/quickstart-cli.mdx b/docs/toolhive/tutorials/quickstart-cli.mdx index 88979358..0ac22ef8 100644 --- a/docs/toolhive/tutorials/quickstart-cli.mdx +++ b/docs/toolhive/tutorials/quickstart-cli.mdx @@ -282,8 +282,8 @@ thv rm fetch :::info[What's happening?] Stopping a server pauses it and terminates the associated proxy process but -keeps the container around so you can restart it quickly later using -[`thv restart`](../reference/cli/thv_restart.md) or +keeps the container around so you can start it quickly later using +[`thv start`](../reference/cli/thv_start.md) or [`thv run`](../reference/cli/thv_run.md). Removing a server completely deletes the container, freeing up resources.