Skip to content

Commit 4ceddbb

Browse files
ChrisJBurnsclaude
andcommitted
Address review findings from Copilot and code review
- Fix ConfigMap source example: use volumes/volumeMounts with file path instead of CRD-level configMapRef inside configYAML - Fix URL source example: use file.url instead of CRD-level url.endpoint inside configYAML - Fix file source docs: clarify file.path and file.url are mutually exclusive within the file block - Add MCPServerEntry transport options (sse and streamable-http) - Fix resource type count: "three" → "four" in K8s intro - Align "running" → "ready" in vMCP quickstart preceding text Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 3045d10 commit 4ceddbb

File tree

5 files changed

+26
-17
lines changed

5 files changed

+26
-17
lines changed

docs/toolhive/guides-k8s/intro.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ or Gateway. To learn how to expose your MCP servers and connect clients, see
6767

6868
## Which resource type should I use?
6969

70-
The operator introduces three resource types for MCP workloads. Choose based on
70+
The operator introduces four resource types for MCP workloads. Choose based on
7171
where your MCP server runs and how many servers you need to manage:
7272

7373
| Resource | Use when |

docs/toolhive/guides-registry/configuration.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -286,16 +286,16 @@ registries:
286286
sources: ['remote']
287287
```
288288

289-
The fields `file` and `url` are mutually exclusive.
289+
Within the `file` block, `path` and `url` are mutually exclusive.
290290

291291
**Configuration options:**
292292

293-
- `path` (required): Path to the registry file on the filesystem. Mutually
294-
exclusive with `url`
295-
- `url` (required): URL is the HTTP/HTTPS URL to fetch the registry file from.
296-
Mutually exclusive with `file`
297-
- `timeout` (optional): The timeout for HTTP requests when using URL, defaults
298-
to 30s, ignored when `file` is specified
293+
- `file.path` (required): Path to the registry file on the filesystem. Mutually
294+
exclusive with `file.url`
295+
- `file.url` (required): HTTP/HTTPS URL to fetch the registry file from.
296+
Mutually exclusive with `file.path`
297+
- `file.timeout` (optional): The timeout for HTTP requests when using `url`,
298+
defaults to 30s
299299

300300
### Managed registry
301301

docs/toolhive/guides-registry/deploy-operator.mdx

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -181,22 +181,29 @@ precedence over `branch`.
181181

182182
### ConfigMap source
183183

184-
Read from a Kubernetes ConfigMap. Ideal for registry data managed within the
185-
cluster.
184+
Read from a Kubernetes ConfigMap. Mount the ConfigMap as a volume and reference
185+
the file path in `configYAML`.
186186

187187
```yaml title="registry-configmap.yaml"
188188
apiVersion: toolhive.stacklok.dev/v1alpha1
189189
kind: MCPRegistry
190190
metadata:
191191
name: configmap-registry
192192
spec:
193+
volumes:
194+
- name: registry-data
195+
configMap:
196+
name: registry-data
197+
volumeMounts:
198+
- name: registry-data
199+
mountPath: /data/registry
200+
readOnly: true
193201
configYAML: |
194202
sources:
195203
- name: local
196204
format: upstream
197-
configMapRef:
198-
name: registry-data
199-
key: registry.json
205+
file:
206+
path: /data/registry/registry.json
200207
syncPolicy:
201208
interval: '15m'
202209
registries:
@@ -273,8 +280,8 @@ spec:
273280
sources:
274281
- name: remote
275282
format: upstream
276-
url:
277-
endpoint: https://example.com/registry.json
283+
file:
284+
url: https://example.com/registry.json
278285
syncPolicy:
279286
interval: '1h'
280287
registries:

docs/toolhive/guides-vmcp/configuration.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,9 +104,11 @@ metadata:
104104
spec:
105105
groupRef: my-group # Reference to the MCPGroup
106106
remoteURL: https://mcp.example.com/mcp
107-
transport: streamable-http
107+
transport: streamable-http # or sse
108108
```
109109

110+
The `transport` field is required and accepts `streamable-http` or `sse`.
111+
110112
MCPServerEntry supports optional configuration for authentication and TLS:
111113

112114
```yaml

docs/toolhive/guides-vmcp/quickstart.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ Apply the resources:
104104
kubectl apply -f mcpservers.yaml
105105
```
106106

107-
Wait for both servers to be running:
107+
Wait for both servers to be ready:
108108

109109
```bash
110110
kubectl get mcpservers -n toolhive-system -w

0 commit comments

Comments
 (0)