Skip to content

Commit 675178b

Browse files
authored
Merge pull request #49 from StacklokLabs/add-toolhive-packaged-instructions
Add ToolHive packaged usage instructions
2 parents ac769a9 + 9afd152 commit 675178b

File tree

1 file changed

+34
-7
lines changed

1 file changed

+34
-7
lines changed

README.md

Lines changed: 34 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -413,17 +413,38 @@ task deps
413413

414414
## Running as an MCP Server with ToolHive
415415

416-
MKP can be run as a Model Context Protocol (MCP) server using [ToolHive](https://github.com/StacklokLabs/toolhive), which simplifies the deployment and management of MCP servers.
416+
MKP can be run as a Model Context Protocol (MCP) server using [ToolHive](https://github.com/stacklok/toolhive), which simplifies the deployment and management of MCP servers.
417417

418418
### Prerequisites
419419

420-
1. Install ToolHive by following the [installation instructions](https://github.com/StacklokLabs/toolhive#installation).
420+
1. Install ToolHive by following the [installation instructions](https://github.com/stacklok/toolhive#installation).
421421
2. Ensure you have Docker or Podman installed on your system.
422422
3. Configure your Kubernetes credentials (kubeconfig) for the cluster you want to interact with.
423423

424-
### Running MKP with ToolHive
424+
### Running MKP with ToolHive (Recommended)
425425

426-
To run MKP as an MCP server using ToolHive:
426+
The easiest way to run MKP is using the packaged version available in ToolHive's registry:
427+
428+
```bash
429+
# Enable auto-discovery to automatically configure supported clients
430+
thv config auto-discovery true
431+
432+
# Run the MKP server (packaged as 'k8s' in ToolHive)
433+
# Mount your kubeconfig so the server can access your Kubernetes cluster
434+
thv run --volume $HOME/.kube:/home/nonroot/.kube:ro k8s
435+
436+
# List running servers
437+
thv list
438+
439+
# Get detailed information about the server
440+
thv registry info k8s
441+
```
442+
443+
This will mount your Kubernetes credentials and make the server available to your MCP-compatible clients.
444+
445+
### Advanced Usage with Custom Configuration
446+
447+
For advanced users who need custom configuration, you can also run MKP using the container image directly:
427448

428449
```bash
429450
# Run the MKP server using the published container image
@@ -442,7 +463,7 @@ To use a specific version instead of the latest:
442463
thv run --name mkp --transport sse --target-port 8080 --volume $HOME/.kube:/home/nonroot/.kube:ro ghcr.io/stackloklabs/mkp/server:v0.0.1
443464
```
444465

445-
### Verifying the MKP Server is Running
466+
### Managing the MKP Server
446467

447468
To verify that the MKP server is running:
448469

@@ -452,17 +473,23 @@ thv list
452473

453474
This will show all running MCP servers managed by ToolHive, including the MKP server.
454475

455-
### Stopping the MKP Server
456-
457476
To stop the MKP server:
458477

459478
```bash
479+
# For packaged version
480+
thv stop k8s
481+
482+
# For custom named version
460483
thv stop mkp
461484
```
462485

463486
To remove the server instance completely:
464487

465488
```bash
489+
# For packaged version
490+
thv rm k8s
491+
492+
# For custom named version
466493
thv rm mkp
467494
```
468495

0 commit comments

Comments
 (0)