Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/toolhive/reference/crds/embeddingserver.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ toc_max_heading_level: 4

`EmbeddingServer` defines a containerized embedding model server managed by the ToolHive operator. The [VirtualMCPServer](./virtualmcpserver.mdx) optimizer references an `EmbeddingServer` to generate vector embeddings for tool discovery.

**API:** `toolhive.stacklok.dev/v1alpha1`
**API:** `toolhive.stacklok.dev/v1beta1`
· **Scope:** Namespaced · **Short names:** `emb`, `embedding`

## Example

```yaml title="embeddingserver.yaml"
apiVersion: toolhive.stacklok.dev/v1alpha1
apiVersion: toolhive.stacklok.dev/v1beta1
kind: EmbeddingServer
metadata:
name: my-embeddingserver
Expand Down
4 changes: 2 additions & 2 deletions docs/toolhive/reference/crds/mcpexternalauthconfig.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ toc_max_heading_level: 4

`MCPExternalAuthConfig` configures how an MCP server or proxy authenticates to external services via token exchange or an embedded authorization server. It is referenced by [MCPServer](./mcpserver.mdx), [MCPRemoteProxy](./mcpremoteproxy.mdx), [MCPServerEntry](./mcpserverentry.mdx), and [VirtualMCPServer](./virtualmcpserver.mdx).

**API:** `toolhive.stacklok.dev/v1alpha1`
**API:** `toolhive.stacklok.dev/v1beta1`
· **Scope:** Namespaced · **Short names:** `extauth`, `mcpextauth`

## Example

```yaml title="mcpexternalauthconfig.yaml"
apiVersion: toolhive.stacklok.dev/v1alpha1
apiVersion: toolhive.stacklok.dev/v1beta1
kind: MCPExternalAuthConfig
metadata:
name: my-mcpexternalauthconfig
Expand Down
4 changes: 2 additions & 2 deletions docs/toolhive/reference/crds/mcpgroup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ toc_max_heading_level: 4

`MCPGroup` is a grouping construct for backend workloads. Other resources reference an `MCPGroup` by name to join a shared pool - for example, a [VirtualMCPServer](./virtualmcpserver.mdx) aggregates the tools exposed by every member of its referenced group.

**API:** `toolhive.stacklok.dev/v1alpha1`
**API:** `toolhive.stacklok.dev/v1beta1`
· **Scope:** Namespaced · **Short names:** `mcpg`, `mcpgroup`

## Example

```yaml title="mcpgroup.yaml"
apiVersion: toolhive.stacklok.dev/v1alpha1
apiVersion: toolhive.stacklok.dev/v1beta1
kind: MCPGroup
metadata:
name: my-mcpgroup
Expand Down
4 changes: 2 additions & 2 deletions docs/toolhive/reference/crds/mcpoidcconfig.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ toc_max_heading_level: 4

`MCPOIDCConfig` defines OIDC authentication settings that can be shared across multiple MCP workloads. [MCPServer](./mcpserver.mdx), [MCPRemoteProxy](./mcpremoteproxy.mdx), and [VirtualMCPServer](./virtualmcpserver.mdx) reference an `MCPOIDCConfig` via `spec.oidcConfigRef` to validate incoming tokens.

**API:** `toolhive.stacklok.dev/v1alpha1`
**API:** `toolhive.stacklok.dev/v1beta1`
· **Scope:** Namespaced · **Short names:** `mcpoidc`

## Example

```yaml title="mcpoidcconfig.yaml"
apiVersion: toolhive.stacklok.dev/v1alpha1
apiVersion: toolhive.stacklok.dev/v1beta1
kind: MCPOIDCConfig
metadata:
name: my-mcpoidcconfig
Expand Down
4 changes: 2 additions & 2 deletions docs/toolhive/reference/crds/mcpregistry.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ toc_max_heading_level: 4

`MCPRegistry` deploys a [ToolHive Registry Server](../../guides-registry/intro.mdx) in the cluster. The operator watches `MCPRegistry` resources and provisions the Registry Server, its PostgreSQL backing, and the configured sources (Git, ConfigMap, URL, or Kubernetes discovery) that populate its catalog of MCP server definitions.

**API:** `toolhive.stacklok.dev/v1alpha1`
**API:** `toolhive.stacklok.dev/v1beta1`
· **Scope:** Namespaced · **Short names:** `mcpreg`, `registry`

## Example

```yaml title="mcpregistry.yaml"
apiVersion: toolhive.stacklok.dev/v1alpha1
apiVersion: toolhive.stacklok.dev/v1beta1
kind: MCPRegistry
metadata:
name: my-mcpregistry
Expand Down
4 changes: 2 additions & 2 deletions docs/toolhive/reference/crds/mcpremoteproxy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ toc_max_heading_level: 4

`MCPRemoteProxy` fronts a remote MCP server (reachable over HTTPS) with the same authentication, telemetry, and tool-filtering features that the operator applies to containerized servers. Use this when you want to apply ToolHive policies to a third-party hosted MCP endpoint.

**API:** `toolhive.stacklok.dev/v1alpha1`
**API:** `toolhive.stacklok.dev/v1beta1`
· **Scope:** Namespaced · **Short names:** `rp`, `mcprp`

## Example

```yaml title="mcpremoteproxy.yaml"
apiVersion: toolhive.stacklok.dev/v1alpha1
apiVersion: toolhive.stacklok.dev/v1beta1
kind: MCPRemoteProxy
metadata:
name: my-mcpremoteproxy
Expand Down
4 changes: 2 additions & 2 deletions docs/toolhive/reference/crds/mcpserver.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ toc_max_heading_level: 4

`MCPServer` defines a containerized MCP server managed by the ToolHive Kubernetes operator. The operator watches `MCPServer` resources and reconciles them into a running, proxied MCP server with the configured transport, authentication, telemetry, and tool filtering.

**API:** `toolhive.stacklok.dev/v1alpha1`
**API:** `toolhive.stacklok.dev/v1beta1`
· **Scope:** Namespaced · **Short names:** `mcpserver`, `mcpservers`

## Example

```yaml title="mcpserver.yaml"
apiVersion: toolhive.stacklok.dev/v1alpha1
apiVersion: toolhive.stacklok.dev/v1beta1
kind: MCPServer
metadata:
name: my-mcpserver
Expand Down
4 changes: 2 additions & 2 deletions docs/toolhive/reference/crds/mcpserverentry.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ toc_max_heading_level: 4

`MCPServerEntry` declares a remote MCP server as a first-class member of an [MCPGroup](./mcpgroup.mdx) without running a full [MCPRemoteProxy](./mcpremoteproxy.mdx). Entries appear in registry listings and participate in group-scoped aggregations like a [VirtualMCPServer](./virtualmcpserver.mdx).

**API:** `toolhive.stacklok.dev/v1alpha1`
**API:** `toolhive.stacklok.dev/v1beta1`
· **Scope:** Namespaced · **Short names:** `mcpentry`

## Example

```yaml title="mcpserverentry.yaml"
apiVersion: toolhive.stacklok.dev/v1alpha1
apiVersion: toolhive.stacklok.dev/v1beta1
kind: MCPServerEntry
metadata:
name: my-mcpserverentry
Expand Down
4 changes: 2 additions & 2 deletions docs/toolhive/reference/crds/mcptelemetryconfig.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ toc_max_heading_level: 4

`MCPTelemetryConfig` defines telemetry settings that can be shared across multiple MCP workloads. [MCPServer](./mcpserver.mdx), [MCPRemoteProxy](./mcpremoteproxy.mdx), and [VirtualMCPServer](./virtualmcpserver.mdx) reference a single `MCPTelemetryConfig` to emit traces and metrics to a common backend.

**API:** `toolhive.stacklok.dev/v1alpha1`
**API:** `toolhive.stacklok.dev/v1beta1`
· **Scope:** Namespaced · **Short names:** `mcpotel`

## Example

```yaml title="mcptelemetryconfig.yaml"
apiVersion: toolhive.stacklok.dev/v1alpha1
apiVersion: toolhive.stacklok.dev/v1beta1
kind: MCPTelemetryConfig
metadata:
name: my-mcptelemetryconfig
Expand Down
4 changes: 2 additions & 2 deletions docs/toolhive/reference/crds/mcptoolconfig.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ toc_max_heading_level: 4

`MCPToolConfig` defines tool-filtering and renaming rules that can be shared across MCP workloads. [MCPServer](./mcpserver.mdx), [MCPRemoteProxy](./mcpremoteproxy.mdx), and [VirtualMCPServer](./virtualmcpserver.mdx) reference an `MCPToolConfig` via `spec.toolConfigRef` to customize the tool surface their clients see.

**API:** `toolhive.stacklok.dev/v1alpha1`
**API:** `toolhive.stacklok.dev/v1beta1`
· **Scope:** Namespaced · **Short names:** `tc`, `toolconfig`

## Example

```yaml title="mcptoolconfig.yaml"
apiVersion: toolhive.stacklok.dev/v1alpha1
apiVersion: toolhive.stacklok.dev/v1beta1
kind: MCPToolConfig
metadata:
name: my-mcptoolconfig
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ toc_max_heading_level: 4

`VirtualMCPCompositeToolDefinition` defines a reusable composite tool workflow - a sequence of backend tool calls exposed to clients as a single high-level tool. Referenced by a [VirtualMCPServer](./virtualmcpserver.mdx) via `spec.config.compositeToolRefs`.

**API:** `toolhive.stacklok.dev/v1alpha1`
**API:** `toolhive.stacklok.dev/v1beta1`
· **Scope:** Namespaced · **Short names:** `vmcpctd`, `compositetool`

## Example

```yaml title="virtualmcpcompositetooldefinition.yaml"
apiVersion: toolhive.stacklok.dev/v1alpha1
apiVersion: toolhive.stacklok.dev/v1beta1
kind: VirtualMCPCompositeToolDefinition
metadata:
name: my-virtualmcpcompositetooldefinition
Expand Down
4 changes: 2 additions & 2 deletions docs/toolhive/reference/crds/virtualmcpserver.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ toc_max_heading_level: 4

`VirtualMCPServer` (vMCP) aggregates the backend workloads belonging to an [MCPGroup](./mcpgroup.mdx) into a single endpoint. Clients see one MCP server; the operator handles tool aggregation, conflict resolution, auth, and optional composite tool workflows behind the scenes.

**API:** `toolhive.stacklok.dev/v1alpha1`
**API:** `toolhive.stacklok.dev/v1beta1`
· **Scope:** Namespaced · **Short names:** `vmcp`, `virtualmcp`

## Example

```yaml title="virtualmcpserver.yaml"
apiVersion: toolhive.stacklok.dev/v1alpha1
apiVersion: toolhive.stacklok.dev/v1beta1
kind: VirtualMCPServer
metadata:
name: my-virtualmcpserver
Expand Down
2 changes: 1 addition & 1 deletion static/api-specs/crds/embeddingservers.example.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
apiVersion: toolhive.stacklok.dev/v1alpha1
apiVersion: toolhive.stacklok.dev/v1beta1
kind: EmbeddingServer
metadata:
name: my-embeddingserver
Expand Down
2 changes: 1 addition & 1 deletion static/api-specs/crds/embeddingservers.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"description": "EmbeddingServer is the Schema for the embeddingservers API",
"x-kubernetes-group": "toolhive.stacklok.dev",
"x-kubernetes-kind": "EmbeddingServer",
"x-kubernetes-version": "v1alpha1",
"x-kubernetes-version": "v1beta1",
"x-kubernetes-plural": "embeddingservers",
"x-kubernetes-short-names": [
"emb",
Expand Down
24 changes: 12 additions & 12 deletions static/api-specs/crds/index.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"kind": "EmbeddingServer",
"plural": "embeddingservers",
"group": "toolhive.stacklok.dev",
"version": "v1alpha1",
"version": "v1beta1",
"shortNames": [
"emb",
"embedding"
Expand All @@ -25,7 +25,7 @@
"kind": "MCPExternalAuthConfig",
"plural": "mcpexternalauthconfigs",
"group": "toolhive.stacklok.dev",
"version": "v1alpha1",
"version": "v1beta1",
"shortNames": [
"extauth",
"mcpextauth"
Expand Down Expand Up @@ -68,7 +68,7 @@
"kind": "MCPGroup",
"plural": "mcpgroups",
"group": "toolhive.stacklok.dev",
"version": "v1alpha1",
"version": "v1beta1",
"shortNames": [
"mcpg",
"mcpgroup"
Expand Down Expand Up @@ -109,7 +109,7 @@
"kind": "MCPOIDCConfig",
"plural": "mcpoidcconfigs",
"group": "toolhive.stacklok.dev",
"version": "v1alpha1",
"version": "v1beta1",
"shortNames": [
"mcpoidc"
],
Expand Down Expand Up @@ -142,7 +142,7 @@
"kind": "MCPRegistry",
"plural": "mcpregistries",
"group": "toolhive.stacklok.dev",
"version": "v1alpha1",
"version": "v1beta1",
"shortNames": [
"mcpreg",
"registry"
Expand All @@ -157,7 +157,7 @@
"kind": "MCPRemoteProxy",
"plural": "mcpremoteproxies",
"group": "toolhive.stacklok.dev",
"version": "v1alpha1",
"version": "v1beta1",
"shortNames": [
"rp",
"mcprp"
Expand Down Expand Up @@ -204,7 +204,7 @@
"kind": "MCPServerEntry",
"plural": "mcpserverentries",
"group": "toolhive.stacklok.dev",
"version": "v1alpha1",
"version": "v1beta1",
"shortNames": [
"mcpentry"
],
Expand All @@ -231,7 +231,7 @@
"kind": "MCPServer",
"plural": "mcpservers",
"group": "toolhive.stacklok.dev",
"version": "v1alpha1",
"version": "v1beta1",
"shortNames": [
"mcpserver",
"mcpservers"
Expand Down Expand Up @@ -278,7 +278,7 @@
"kind": "MCPTelemetryConfig",
"plural": "mcptelemetryconfigs",
"group": "toolhive.stacklok.dev",
"version": "v1alpha1",
"version": "v1beta1",
"shortNames": [
"mcpotel"
],
Expand Down Expand Up @@ -311,7 +311,7 @@
"kind": "MCPToolConfig",
"plural": "mcptoolconfigs",
"group": "toolhive.stacklok.dev",
"version": "v1alpha1",
"version": "v1beta1",
"shortNames": [
"tc",
"toolconfig"
Expand Down Expand Up @@ -345,7 +345,7 @@
"kind": "VirtualMCPCompositeToolDefinition",
"plural": "virtualmcpcompositetooldefinitions",
"group": "toolhive.stacklok.dev",
"version": "v1alpha1",
"version": "v1beta1",
"shortNames": [
"vmcpctd",
"compositetool"
Expand All @@ -367,7 +367,7 @@
"kind": "VirtualMCPServer",
"plural": "virtualmcpservers",
"group": "toolhive.stacklok.dev",
"version": "v1alpha1",
"version": "v1beta1",
"shortNames": [
"vmcp",
"virtualmcp"
Expand Down
2 changes: 1 addition & 1 deletion static/api-specs/crds/mcpexternalauthconfigs.example.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
apiVersion: toolhive.stacklok.dev/v1alpha1
apiVersion: toolhive.stacklok.dev/v1beta1
kind: MCPExternalAuthConfig
metadata:
name: my-mcpexternalauthconfig
Expand Down
2 changes: 1 addition & 1 deletion static/api-specs/crds/mcpexternalauthconfigs.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"description": "MCPExternalAuthConfig is the Schema for the mcpexternalauthconfigs API.\nMCPExternalAuthConfig resources are namespace-scoped and can only be referenced by\nMCPServer resources within the same namespace. Cross-namespace references\nare not supported for security and isolation reasons.",
"x-kubernetes-group": "toolhive.stacklok.dev",
"x-kubernetes-kind": "MCPExternalAuthConfig",
"x-kubernetes-version": "v1alpha1",
"x-kubernetes-version": "v1beta1",
"x-kubernetes-plural": "mcpexternalauthconfigs",
"x-kubernetes-short-names": [
"extauth",
Expand Down
2 changes: 1 addition & 1 deletion static/api-specs/crds/mcpgroups.example.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
apiVersion: toolhive.stacklok.dev/v1alpha1
apiVersion: toolhive.stacklok.dev/v1beta1
kind: MCPGroup
metadata:
name: my-mcpgroup
Expand Down
2 changes: 1 addition & 1 deletion static/api-specs/crds/mcpgroups.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"description": "MCPGroup is the Schema for the mcpgroups API",
"x-kubernetes-group": "toolhive.stacklok.dev",
"x-kubernetes-kind": "MCPGroup",
"x-kubernetes-version": "v1alpha1",
"x-kubernetes-version": "v1beta1",
"x-kubernetes-plural": "mcpgroups",
"x-kubernetes-short-names": [
"mcpg",
Expand Down
2 changes: 1 addition & 1 deletion static/api-specs/crds/mcpoidcconfigs.example.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
apiVersion: toolhive.stacklok.dev/v1alpha1
apiVersion: toolhive.stacklok.dev/v1beta1
kind: MCPOIDCConfig
metadata:
name: my-mcpoidcconfig
Expand Down
2 changes: 1 addition & 1 deletion static/api-specs/crds/mcpoidcconfigs.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"description": "MCPOIDCConfig is the Schema for the mcpoidcconfigs API.\nMCPOIDCConfig resources are namespace-scoped and can only be referenced by\nMCPServer resources within the same namespace. Cross-namespace references\nare not supported for security and isolation reasons.",
"x-kubernetes-group": "toolhive.stacklok.dev",
"x-kubernetes-kind": "MCPOIDCConfig",
"x-kubernetes-version": "v1alpha1",
"x-kubernetes-version": "v1beta1",
"x-kubernetes-plural": "mcpoidcconfigs",
"x-kubernetes-short-names": [
"mcpoidc"
Expand Down
2 changes: 1 addition & 1 deletion static/api-specs/crds/mcpregistries.example.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
apiVersion: toolhive.stacklok.dev/v1alpha1
apiVersion: toolhive.stacklok.dev/v1beta1
kind: MCPRegistry
metadata:
name: my-mcpregistry
Expand Down
2 changes: 1 addition & 1 deletion static/api-specs/crds/mcpregistries.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"description": "MCPRegistry is the Schema for the mcpregistries API",
"x-kubernetes-group": "toolhive.stacklok.dev",
"x-kubernetes-kind": "MCPRegistry",
"x-kubernetes-version": "v1alpha1",
"x-kubernetes-version": "v1beta1",
"x-kubernetes-plural": "mcpregistries",
"x-kubernetes-short-names": [
"mcpreg",
Expand Down
2 changes: 1 addition & 1 deletion static/api-specs/crds/mcpremoteproxies.example.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
apiVersion: toolhive.stacklok.dev/v1alpha1
apiVersion: toolhive.stacklok.dev/v1beta1
kind: MCPRemoteProxy
metadata:
name: my-mcpremoteproxy
Expand Down
2 changes: 1 addition & 1 deletion static/api-specs/crds/mcpremoteproxies.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"description": "MCPRemoteProxy is the Schema for the mcpremoteproxies API\nIt enables proxying remote MCP servers with authentication, authorization, audit logging, and tool filtering",
"x-kubernetes-group": "toolhive.stacklok.dev",
"x-kubernetes-kind": "MCPRemoteProxy",
"x-kubernetes-version": "v1alpha1",
"x-kubernetes-version": "v1beta1",
"x-kubernetes-plural": "mcpremoteproxies",
"x-kubernetes-short-names": [
"rp",
Expand Down
2 changes: 1 addition & 1 deletion static/api-specs/crds/mcpserverentries.example.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
apiVersion: toolhive.stacklok.dev/v1alpha1
apiVersion: toolhive.stacklok.dev/v1beta1
kind: MCPServerEntry
metadata:
name: my-mcpserverentry
Expand Down
Loading