Skip to content

Fix vMCP documentation based on cluster testing #331

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.

Sign up for GitHub

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
JAORMX merged 3 commits into from
Nov 28, 2025
+7 −3
Merged

Fix vMCP documentation based on cluster testing #331

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
de9779f
Fix VirtualMCPServer output columns in quickstart
jhrozek Nov 28, 2025
10a0c19
Fix minimal VirtualMCPServer config to include required incomingAuth
jhrozek Nov 28, 2025
539a5f2
Add note about optional clientSecretRef for token introspection
jhrozek Nov 28, 2025
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
6 changes: 5 additions & 1 deletion docs/toolhive/guides-vmcp/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ complete field reference, see the
## Minimal configuration

At minimum, a VirtualMCPServer requires a reference to an
[MCPGroup](../tutorials/quickstart-vmcp.mdx#step-1-create-an-mcpgroup):
[MCPGroup](../tutorials/quickstart-vmcp.mdx#step-1-create-an-mcpgroup) and an
authentication type:

```yaml
apiVersion: toolhive.stacklok.dev/v1alpha1
Expand All @@ -20,6 +21,8 @@ metadata:
spec:
groupRef:
name: my-group
incomingAuth:
type: anonymous # Disables authentication; do not use in production
```

The MCPGroup must exist in the same namespace and be in a Ready state before the
Expand Down Expand Up @@ -57,6 +60,7 @@ spec:
issuer: https://your-idp.example.com
audience: vmcp
clientId: your-client-id
# For token introspection, add clientSecretRef referencing a Secret
```

### Kubernetes service account tokens
Expand Down
4 changes: 2 additions & 2 deletions docs/toolhive/tutorials/quickstart-vmcp.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,8 +159,8 @@ kubectl get virtualmcpservers -n toolhive-system
You should see output similar to:

```text
NAME STATUS URL AGE
demo-vmcp Ready http://vmcp-demo-vmcp.toolhive-system.svc.cluster.local:4483 30s
NAME PHASE URL BACKENDS AGE READY
demo-vmcp Ready http://vmcp-demo-vmcp.toolhive-system.svc.cluster.local:4483 2 30s True
```

:::info[What's happening?]
Expand Down
Loading