Skip to content

Commit 7fa165e

Browse files
rdimitrovChrisJBurnsclaude
authored
Part 2: Update Registry Server docs for v1.0.0–v1.1.0 (#683)
* Update docs for ToolHive v0.17.0 Breaking changes: - Update CRD phase values from Running to Ready for MCPServer, EmbeddingServer, and MCPRegistry across quickstarts, guides, and integration pages - Migrate MCPRegistry examples from v1 flat registries[] format to v2 sources[]/registries[] with configYAML recommended path - Remove PVC source type (no longer supported) - Remove Syncing phase from MCPRegistry status documentation - Remove auto-injection note for Kubernetes discovery sources New features: - Add MCPServerEntry (zero-infrastructure catalog entries) docs to K8s intro and vMCP configuration pages - Add caBundleRef for OTLP endpoints to telemetry guide - Add authServerRef for separating embedded auth from external token exchange to auth guide - Update standalone registry server config to v2 format Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * 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> * Update Registry Server docs for v1.0.0 and v1.0.1 Restructure configuration docs to reflect the new two-level config model (sources + registries), add a dedicated authorization guide covering RBAC roles and claims-based access control, and update all related pages for cross-document consistency. Key changes: - Rewrite configuration.mdx for sources/registries split - Add authorization.mdx (roles, claims, /v1/me endpoint) - Replace claimMapping with authz-claims annotation docs - Document skills sync from external sources - Document multiple Kubernetes sources support - Add DNS subdomain naming requirement for source names - Update cross-references across deployment, skills, and intro pages - Fix broken anchor in remote-mcp-proxy.mdx Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * Update Registry Server docs for v1.1.0 and address review findings Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * Fix entries-without-claims visibility for auth-only mode Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * Address PR review findings from Dan Barr Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * Remove filler openers from front matter descriptions Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * Use upstream registry format in all examples Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Chris Burns <29541485+ChrisJBurns@users.noreply.github.com> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 90ce596 commit 7fa165e

14 files changed

Lines changed: 836 additions & 211 deletions

docs/toolhive/contributing.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,9 @@ actively being developed and tested.
7070
### Registry server
7171

7272
The Registry Server is an API server that implements the official MCP Registry
73-
API. It provides standardized access to MCP servers from multiple backends,
74-
including file-based and other API-compliant registries.
73+
API. It provides standardized access to MCP servers and skills from multiple
74+
backends, including Git repositories, API endpoints, files, managed sources, and
75+
Kubernetes clusters.
7576

7677
**Repository**:
7778
[stacklok/toolhive-registry-server](https://github.com/stacklok/toolhive-registry-server)

docs/toolhive/guides-k8s/remote-mcp-proxy.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -801,7 +801,7 @@ Learn how to customize MCP tools using
801801
[filters and overrides](./customize-tools.mdx).
802802

803803
Discover your deployed MCP servers automatically using the
804-
[Kubernetes registry](../guides-registry/configuration.mdx#kubernetes-registry)
804+
[Kubernetes source](../guides-registry/configuration.mdx#kubernetes-source)
805805
feature in the ToolHive Registry Server.
806806

807807
## Related information

docs/toolhive/guides-k8s/telemetry-and-metrics.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ spec:
175175

176176
:::note
177177

178-
`caBundleRef` cannot be used when `insecure` is set to `true` - they are
178+
`caBundleRef` cannot be used when `insecure` is set to `true` they are
179179
mutually exclusive.
180180

181181
:::

docs/toolhive/guides-registry/authentication.mdx

Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,14 @@ OAuth mode to protect your registry. You can configure authentication to fit
1010
different deployment scenarios, from development environments to production
1111
deployments with enterprise identity providers.
1212

13+
:::tip[Looking for authorization?]
14+
15+
This page covers **authentication** (verifying caller identity). For
16+
**authorization** (controlling what callers can do), including role-based access
17+
control and claims-based scoping, see [Authorization](./authorization.mdx).
18+
19+
:::
20+
1321
## Authentication modes
1422

1523
The server supports two authentication modes configured via the required `auth`
@@ -346,11 +354,14 @@ anonymous mode in production.**
346354
The following endpoints are **always accessible without authentication**,
347355
regardless of the auth mode:
348356

349-
- `/health` - Health check endpoint
350-
- `/readiness` - Readiness probe endpoint
351-
- `/version` - Version information
357+
- `/openapi.json` - OpenAPI specification
352358
- `/.well-known/*` - OAuth discovery endpoints (RFC 9728)
353359

360+
The `/health`, `/readiness`, and `/version` endpoints are served on a separate
361+
internal server (default port 8081) and are not exposed on the main API port.
362+
See the [command-line flags](./configuration.mdx#command-line-flags) for the
363+
`--internal-address` option.
364+
354365
You can configure additional public paths using the `publicPaths` field in your
355366
OAuth configuration. See the
356367
[Registry API reference](../reference/registry-api.mdx) for complete endpoint
@@ -499,6 +510,14 @@ providers:
499510
caCertPath: /etc/ssl/certs/internal-ca.crt
500511
```
501512

513+
## Next steps
514+
515+
- [Configure authorization](./authorization.mdx) to set up role-based access
516+
control and claims-based scoping
517+
- [Set up the database](./database.mdx) for production storage and migrations
518+
- [Configure telemetry](./telemetry-metrics.mdx) for distributed tracing and
519+
metrics collection
520+
502521
## Troubleshooting
503522

504523
### 401 Unauthorized errors
@@ -544,9 +563,3 @@ If tokens from some providers work but others don't:
544563
4. Review server logs to identify which specific provider validation is failing
545564
5. Test each provider's JWKS endpoint accessibility:
546565
`curl ${issuerUrl}/.well-known/openid-configuration`
547-
548-
## Next steps
549-
550-
- [Set up the database](./database.mdx) for production storage and migrations
551-
- [Configure telemetry](./telemetry-metrics.mdx) for distributed tracing and
552-
metrics collection

0 commit comments

Comments
 (0)