Configuration

All configuration is done via YAML files. The server requires a --config flag pointing to a YAML configuration file.

Configuration file structure

config.yaml

# Registry name/identifier (optional, defaults to "default")
registryName: my-registry

# Registries configuration (required, can have multiple registries)
registries:
  - name: toolhive
    # Data format: toolhive (native) or upstream (MCP registry format)
    format: toolhive

    # Git repository configuration
    git:
      repository: https://github.com/stacklok/toolhive.git
      branch: main
      path: pkg/registry/data/registry.json

    # Per-registry automatic sync policy (required for synced registries)
    syncPolicy:
      # Sync interval (e.g., "30m", "1h", "24h")
      interval: '30m'

    # Optional: Per-registry server filtering
    filter:
      names:
        include: ['official/*']
        exclude: ['*/deprecated']
      tags:
        include: ['production']
        exclude: ['experimental']

# Authentication configuration (required)
auth:
  # Mode: anonymous or oauth (defaults to oauth if not specified)
  mode: anonymous

# Optional: Database configuration
database:
  host: localhost
  port: 5432
  user: registry
  database: registry
  sslMode: require
  maxOpenConns: 25
  maxIdleConns: 5
  connMaxLifetime: '5m'

Command-line flags

Flag	Description	Required	Default
--config	Path to YAML configuration file	Yes	-
--address	Server listen address	No	:8080

Data sources

The server supports five registry types, each with its own configuration options. You can configure multiple registries in a single server instance.

Git repository source

Clone and sync from Git repositories. Ideal for version-controlled registries.

config-git.yaml

registries:
  - name: toolhive
    format: toolhive
    git:
      repository: https://github.com/stacklok/toolhive.git
      branch: main
      path: pkg/registry/data/registry.json
    syncPolicy:
      interval: '30m'

auth:
  mode: anonymous

Configuration options:

• repository (required): Git repository URL
• branch (optional): Branch name to use (defaults to main)
• tag (optional): Tag name to pin to a specific version
• commit (optional): Commit SHA to pin to a specific commit
• path (required): Path to the registry file within the repository

tip

You can use branch, tag, or commit to pin to a specific version. If multiple are specified, commit takes precedence over tag, which takes precedence over branch.

API endpoint source

Sync from upstream MCP Registry APIs. Supports federation and aggregation scenarios.

config-api.yaml

registries:
  - name: mcp-upstream
    format: upstream
    api:
      endpoint: https://registry.modelcontextprotocol.io
    syncPolicy:
      interval: '1h'

auth:
  mode: anonymous

Configuration options:

• endpoint (required): Base URL of the upstream MCP Registry API (without path)
• format (required): Must be upstream for API sources

note

The server automatically appends the appropriate API paths (/v0.1/servers, etc.) to the endpoint URL.

Local file source

Read from filesystem. Ideal for local development and testing.

config-file.yaml

registries:
  - name: local
    format: toolhive
    file:
      path: /data/registry.json
    syncPolicy:
      interval: '15m'

auth:
  mode: anonymous

Configuration options:

• path (required): Path to the registry file on the filesystem

Managed registry

API-managed registry for directly publishing and deleting MCP servers via the API. Does not sync from external sources.

config-managed.yaml

registries:
  - name: internal
    format: toolhive
    managed: {}

auth:
  mode: oauth
  oauth:
    resourceUrl: https://registry.example.com
    providers:
      - name: keycloak
        issuerUrl: https://keycloak.example.com/realms/mcp
        audience: registry-api

Configuration options:

• managed (required): Empty object to indicate managed registry type
• No sync policy required (managed registries are updated via API, not synced)

Supported operations:

• POST /{registryName}/v0.1/publish - Publish new server versions
• DELETE /{registryName}/v0.1/servers/{name}/versions/{version} - Delete versions
• GET operations for listing and retrieving servers

Kubernetes registry

Discovers MCP servers from running Kubernetes deployments. Automatically creates registry entries for deployed MCP servers in your cluster.

config-kubernetes.yaml

registries:
  - name: k8s-cluster
    format: toolhive
    kubernetes: {}

auth:
  mode: oauth
  oauth:
    resourceUrl: https://registry.example.com
    providers:
      - name: kubernetes
        issuerUrl: https://kubernetes.default.svc.cluster.local
        audience: https://kubernetes.default.svc.cluster.local
        caCertPath: /var/run/secrets/kubernetes.io/serviceaccount/ca.crt

Configuration options:

• kubernetes (required): Empty object to indicate Kubernetes registry type
• No sync policy required (Kubernetes registries query live deployments on-demand)

Use cases:

• Discover MCP servers deployed via ToolHive Operator
• Automatically expose running MCP servers to knowledge workers
• Separate MCP server development from user consumption

Sync policy

Configure automatic synchronization of registry data on a per-registry basis. Only applicable to synced registries (Git, API, File). Not required for managed or Kubernetes registries.

registries:
  - name: toolhive
    git:
      repository: https://github.com/stacklok/toolhive.git
      branch: main
      path: pkg/registry/data/registry.json
    syncPolicy:
      # Sync interval (e.g., "30m", "1h", "24h")
      interval: '30m'

The interval field specifies how often the server should fetch updates from the data source. Use Go duration format (e.g., "30m", "1h", "24h").

note

Sync policy is per-registry and must be specified within each registry configuration. Managed and Kubernetes registries do not require sync policies.

Server filtering

Optionally filter which servers are exposed through the API on a per-registry basis. Only applicable to synced registries (Git, API, File).

registries:
  - name: toolhive
    git:
      repository: https://github.com/stacklok/toolhive.git
      branch: main
      path: pkg/registry/data/registry.json
    syncPolicy:
      interval: '30m'
    filter:
      names:
        include: ['official/*']
        exclude: ['*/deprecated']
      tags:
        include: ['production']
        exclude: ['experimental']

Filter options:

• names.include: List of name patterns to include (supports wildcards)
• names.exclude: List of name patterns to exclude (supports wildcards)
• tags.include: List of tags that servers must have
• tags.exclude: List of tags that servers must not have

note

Filters are per-registry and specified within each registry configuration.

Database configuration

The server optionally supports PostgreSQL database connectivity for storing registry state and metadata. See the Database configuration guide for detailed information.

Next steps

• Deploy the server with your configuration
• Configure database storage for production use