From b77bc980a68996745ff39a1be8e372701693c6c6 Mon Sep 17 00:00:00 2001 From: Giuseppe Scuglia Date: Tue, 5 May 2026 19:36:51 +0200 Subject: [PATCH 1/2] Document Registry Server API registry type 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) --- docs/toolhive/guides-ui/registry.mdx | 47 ++++++++++++++++++---------- 1 file changed, 31 insertions(+), 16 deletions(-) diff --git a/docs/toolhive/guides-ui/registry.mdx b/docs/toolhive/guides-ui/registry.mdx index ff685939..97dfc12a 100644 --- a/docs/toolhive/guides-ui/registry.mdx +++ b/docs/toolhive/guides-ui/registry.mdx @@ -100,31 +100,46 @@ in the **MCP Servers** page where you can ## Registry settings To configure your registry, ToolHive provides a dedicated **Registry** settings -section in **Settings** → **Registry** with three options: +section in **Settings** → **Registry** with four options: - **Default Registry** - Use ToolHive's built-in verified registry -- **Remote Registry (URL)** - Specify a custom URL for a remote registry hosted - on a web server -- **Local Registry (File Path)** - Specify a local file path to a JSON registry - file on your system +- **Remote Registry (JSON URL)** - Specify a URL pointing to a static JSON + registry file hosted on a web server +- **Local Registry (JSON File Path)** - Specify a local file path to a JSON + registry file on your system +- **Registry Server API** - Connect to a + [ToolHive Registry Server](../guides-registry/index.mdx) endpoint with + optional OIDC authentication -When you select **Local Registry (File Path)**, an additional **Registry File -Path** field appears where you need to provide the absolute path to your local -JSON registry file (for example: `/path/myregistry/db.json`). Click **Save** to -apply your configuration. +When you select **Local Registry (JSON File Path)**, a **Registry File Path** +field appears where you provide the absolute path to your local JSON registry +file (for example: `/path/myregistry/db.json`). -For detailed information on creating a custom registry, see the -[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 +requires authentication, expand the **Authenticate with your OIDC provider** +section and enter the following fields: + +- **Client ID** - The OAuth client ID registered with your identity provider +- **Issuer URL** - The OIDC issuer URL for your identity provider (for example: + `https://accounts.example.com`) + +After you save, ToolHive initiates the OAuth login flow with your OIDC provider. -:::tip[Host your own registry] +:::tip -You can deploy the [ToolHive Registry Server](../guides-registry/index.mdx) to -host a registry with authentication, multiple data sources, and automatic -synchronization. Point the **Remote Registry (URL)** setting to your Registry -Server endpoint. +The **Registry Server API** option allows private IP addresses and HTTP +connections, so you can use it with a locally hosted Registry Server during +development. ::: +Click **Save** to apply your configuration. + +For detailed information on creating a custom registry, see the +[custom registry tutorial](../tutorials/custom-registry.mdx). + Date: Tue, 5 May 2026 19:47:01 +0200 Subject: [PATCH 2/2] Fix Registry Server API example URL 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) --- docs/toolhive/guides-ui/registry.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/toolhive/guides-ui/registry.mdx b/docs/toolhive/guides-ui/registry.mdx index 97dfc12a..15a6b269 100644 --- a/docs/toolhive/guides-ui/registry.mdx +++ b/docs/toolhive/guides-ui/registry.mdx @@ -117,7 +117,7 @@ file (for example: `/path/myregistry/db.json`). 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 +`https://registry.example.com:8080/registry/default`). If your Registry Server requires authentication, expand the **Authenticate with your OIDC provider** section and enter the following fields: