Skip to content

Commit 0b912f2

Browse files
committed
Update docs for run --from-config
Signed-off-by: lujunsan <[email protected]>
1 parent a4dc1da commit 0b912f2

File tree

3 files changed

+17
-4
lines changed

3 files changed

+17
-4
lines changed

docs/toolhive/guides-cli/run-mcp-servers.mdx

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -527,9 +527,18 @@ For example, to run a server using the exported configuration:
527527
thv run --from-config ./fetch-config.json
528528
```
529529

530-
This creates a new server instance with identical settings to the original. If
531-
the original server used secrets, you must have the same secrets available in
532-
your ToolHive secrets store.
530+
This creates a persistent server instance with identical settings to the original
531+
and saves a real configuration file. The server can be stopped, restarted, and
532+
managed like any other workload. If the original server used secrets, you must
533+
have the same secrets available in your ToolHive secrets store.
534+
535+
:::note
536+
537+
When using `--from-config`, no other command-line flags can be used to avoid
538+
unexpected behavior. All configuration must be specified in the configuration
539+
file.
540+
541+
:::
533542

534543
## Next steps
535544

docs/toolhive/reference/cli/thv_export.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ Export a workload's run configuration to a file
1818
Export a workload's run configuration to a file for sharing or backup.
1919

2020
The exported configuration can be used with 'thv run --from-config <path>' to recreate
21-
the same workload with identical settings.
21+
the same workload with identical settings as a persistent server that can be
22+
stopped, restarted, and managed like any other workload.
2223

2324
Examples:
2425

docs/toolhive/reference/cli/thv_run.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,9 @@ ToolHive supports five ways to run an MCP server:
4949
$ thv run --from-config <path>
5050

5151
Runs an MCP server using a previously exported configuration file.
52+
This saves a real configuration file and creates a persistent workload that
53+
can be stopped, restarted, and managed like any other server. Cannot
54+
be used with other flags.
5255

5356
5. Remote MCP server:
5457

0 commit comments

Comments
 (0)