Skip to content

Update Registry Server docs for v1.2#741

Merged
rdimitrov merged 4 commits intomainfrom
update-registry-server-docs-v1.2
Apr 21, 2026
Merged

Update Registry Server docs for v1.2#741
rdimitrov merged 4 commits intomainfrom
update-registry-server-docs-v1.2

Conversation

@rdimitrov
Copy link
Copy Markdown
Member

Description

Updates the Registry Server documentation to reflect behavior through
toolhive-registry-server v1.2.0. Five verification agents cross-checked
every modified claim against the upstream Go source before the review pass.

Covered upstream changes:

  • Add dry-run doc validation skill #724 Drop ToolHive source format support - Registry Server only
    accepts the upstream MCP registry format. format: upstream is removed
    from every example.
  • Fix CRD field issues in vMCP and K8s quickstart docs #720 PUT /v1/entries/{type}/{name}/claims endpoint documented
    (including %2F URL-encoding of names and the JWT-satisfies-both-sides
    authorization rule).
  • docs: clarify Redis session routing is conditional on Redis being configured #727 Claims-required-on-publish rule added as rule 1 in the claim
    rules list; rule 3 now covers the asymmetric "one side had claims, the
    other didn't" case that previously succeeded silently.
  • Add K8s v1beta1 migration guide #719 Single managed source limit documented (admin API returns
    409 Conflict; startup validation rejects the duplicate combinations).
  • Add enterprise documentation constructs #716 Database password / migrationPassword config fields and
    THV_REGISTRY_DATABASE_PASSWORD / THV_REGISTRY_DATABASE_MIGRATIONPASSWORD
    environment variables documented, with explicit precedence:
    dynamicAuth > config field / env var > pgpass file.
  • New Environment variables section in configuration.mdx covering
    THV_REGISTRY_COMPRESS_RESPONSE, WATCH_NAMESPACE, LEADER_ELECTION_ID,
    INSECURE_URL, and the general THV_REGISTRY_* override pattern.
  • Auth-only mode description refined: role checks are pass-throughs and
    GET /v1/me reports every defined role.
  • Registry schema reference pages now correctly scope each format
    (Registry Server is upstream-only; CLI/UI still accept the legacy
    ToolHive format for the built-in registry and file-based registries).

The second commit on this branch addresses internal editorial review
(wording tightening, bullet-shape consistency, split-out of an overloaded
parenthetical, and a singular/plural link fix).

Type of change

  • Documentation update

Related issues/PRs

Tracks upstream releases up through toolhive-registry-server v1.2.0.

Submitter checklist

Content and formatting

  • I have reviewed the content for technical accuracy
  • I have reviewed the content for spelling, grammar, and style

🤖 Generated with Claude Code

Reflect upstream changes through toolhive-registry-server v1.2.0:

- Drop references to the ToolHive source format; the Registry Server
  now only accepts the upstream MCP registry format (#724).
- Document the PUT /v1/entries/{type}/{name}/claims endpoint and the
  requirement that publish requests include claims when authentication
  is enabled (#720, #727).
- Document the single managed source limit and the 409 response on
  duplicate creation (#719).
- Document database password config fields, THV_REGISTRY_DATABASE_*
  environment variables, and the precedence order over pgpass (#716).
- Document the THV_REGISTRY_COMPRESS_RESPONSE, WATCH_NAMESPACE,
  LEADER_ELECTION_ID, and INSECURE_URL environment variables.
- Update managed source endpoint references to /v1/entries paths and
  refine auth-only mode description (role pass-through, /v1/me).
- Drop 'static' from password precedence lead-in so dynamic auth
  appearing as item 1 no longer contradicts the framing.
- Reword the consumer-reads bullet in managed-source operations to
  match the METHOD/path shape of the other bullets.
- Pull the claims requirement out of the publish bullet parenthetical
  into a dedicated follow-on sentence.
- Clarify rule 3 on claim consistency for first-version-had-no-claims.
- Tighten the auth-only mode wording on /v1/me.
- Trim the skills publish note and fix "deploy guides" singular link.
Copilot AI review requested due to automatic review settings April 20, 2026 22:24
@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 20, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs-website Ready Ready Preview, Comment Apr 20, 2026 10:37pm

Request Review

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates ToolHive Registry Server documentation to reflect behavior through toolhive-registry-server v1.2.0, including endpoint changes, upstream-only schema support, and updated auth/claims and configuration guidance.

Changes:

  • Clarifies schema/format support: Registry Server is upstream-format-only; CLI/UI retain legacy ToolHive format support for built-in/file registries.
  • Documents updated managed-source admin APIs (/v1/entries, claims update endpoint) and related authorization/claims rules (including URL-encoded %2F name handling).
  • Expands configuration docs (managed-source constraints, environment variable overrides, and DB password precedence/options).

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
docs/toolhive/reference/registry-schema-upstream.mdx Clarifies upstream-only support for Registry Server; positions legacy format as CLI/UI-only.
docs/toolhive/reference/registry-schema-toolhive.mdx Marks ToolHive-native schema as legacy and scopes its support appropriately.
docs/toolhive/guides-registry/skills.mdx Updates skill publish/claims guidance and documents %2F encoding for entry-name paths.
docs/toolhive/guides-registry/intro.mdx Updates managed source description to reflect /v1/entries admin API publishing.
docs/toolhive/guides-registry/deploy-operator.mdx Removes format: upstream from examples and updates troubleshooting wording to schema mismatch.
docs/toolhive/guides-registry/deploy-manual.mdx Removes format: upstream from the embedded config example.
docs/toolhive/guides-registry/database.mdx Documents password/migrationPassword fields, env vars, and precedence/pgpass guidance.
docs/toolhive/guides-registry/configuration.mdx Removes format-selection section, documents managed-source limits, ops, and adds env var override section.
docs/toolhive/guides-registry/authorization.mdx Updates claims rules, adds claims update endpoint documentation, and refines auth-only mode behavior.

Comment thread docs/toolhive/guides-registry/configuration.mdx
Comment thread docs/toolhive/guides-registry/deploy-manual.mdx Outdated
@rdimitrov rdimitrov added the documentation Improvements or additions to documentation label Apr 20, 2026
- Replace "Pick one" in database password section with a framing that
  matches the precedence chain that follows.
- Broaden the "separate database users" guidance so it applies to every
  credential-delivery method, not just pgpass.
- Drop the redundant "(consumer reads)" trailer from the GET bullet.
- Smooth the claim-consistency sentence in authorization rule 3.
Match the indented list style used elsewhere in the same Deployment
block and across the doc set. The flush style was valid YAML but
inconsistent with surrounding examples.
@rdimitrov rdimitrov merged commit fc2ee65 into main Apr 21, 2026
8 checks passed
@rdimitrov rdimitrov deleted the update-registry-server-docs-v1.2 branch April 21, 2026 06:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants