Skip to content

Document Registry Server API registry type#845

Draft
peppescg wants to merge 2 commits intomainfrom
worktree-registry-server-api-769
Draft

Document Registry Server API registry type#845
peppescg wants to merge 2 commits intomainfrom
worktree-registry-server-api-769

Conversation

@peppescg
Copy link
Copy Markdown
Contributor

@peppescg peppescg commented May 5, 2026

Summary

  • Add the fourth registry option Registry Server API to the registry settings documentation, including OIDC authentication fields (Client ID, Issuer URL) and private IP support
  • Replace the outdated tip that directed users to use Remote Registry (URL) for Registry Server connections
  • Clarify the labels for the existing Remote Registry and Local Registry options to match the current UI

Closes #769

Test plan

  • Verify the site builds successfully
  • Review the updated registry settings section for accuracy against Studio v0.30.0+
  • Confirm OIDC field names and behavior match the UI

🤖 Generated with Claude Code

Add the fourth registry option (Registry Server API) with its OIDC
authentication fields and private IP support. Replace the outdated
tip that directed users to the Remote URL option for Registry Server
connections.

Closes #769

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings May 5, 2026 17:37
@vercel
Copy link
Copy Markdown

vercel Bot commented May 5, 2026

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

Project Deployment Actions Updated (UTC)
docs-website Ready Ready Preview, Comment May 5, 2026 5:47pm

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 the ToolHive UI registry guide to document the new Registry Server API registry type and align the option labels with the current Studio UI. This fits the existing UI docs by correcting how users configure custom registries in the desktop app.

Changes:

  • Adds Registry Server API as a fourth registry option in the UI settings docs.
  • Documents OIDC-related fields for Registry Server connections and notes local/private-network development support.
  • Replaces the old tip that told readers to use Remote Registry for Registry Server connections.

Comment thread docs/toolhive/guides-ui/registry.mdx Outdated
[custom registry tutorial](../tutorials/custom-registry.mdx).
When you select **Registry Server API**, a **Registry Server API URL** field
appears where you provide the URL of your Registry Server endpoint (for example:
`https://registry.example.com:8080/api/registry`). If your Registry Server
@peppescg peppescg self-assigned this May 5, 2026
Use the correct base path format (/registry/default) instead of
/api/registry. The backend appends /v0.1/servers automatically.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Gap]: Document Registry Server API registry type (OIDC, allow_private_ip)

2 participants