-
Notifications
You must be signed in to change notification settings - Fork 2
document vMCP remote server support #406
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -641,6 +641,115 @@ spec: | |
|
|
||
| See [Telemetry and metrics](./telemetry-and-metrics.mdx) for more information. | ||
|
|
||
| ## Use with Virtual MCP Server | ||
|
|
||
| MCPRemoteProxy resources can be added to an MCPGroup and aggregated by a | ||
| VirtualMCPServer, enabling you to combine remote MCP servers with local | ||
| container-based MCPServer resources into a single unified endpoint. | ||
|
|
||
| ### Add remote proxy to a group | ||
|
|
||
| To include a remote proxy in vMCP aggregation, add the `groupRef` field to your | ||
| MCPRemoteProxy spec: | ||
|
|
||
| ```yaml | ||
| apiVersion: toolhive.stacklok.dev/v1alpha1 | ||
| kind: MCPRemoteProxy | ||
| metadata: | ||
| name: analytics-proxy | ||
| namespace: toolhive-system | ||
| spec: | ||
| groupRef: my-group # Reference to an MCPGroup | ||
| remoteURL: https://mcp.analytics.example.com | ||
| transport: streamable-http | ||
| port: 8080 | ||
| oidcConfig: | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What does the oidcConfig here mean? Is it a token that vMCP sends? |
||
| type: inline | ||
| inline: | ||
| issuer: https://auth.company.com/realms/production | ||
| audience: analytics-proxy | ||
| ``` | ||
|
|
||
| ### Benefits of vMCP aggregation | ||
|
|
||
| When remote proxies are part of a vMCP group: | ||
|
|
||
| - **Unified endpoint**: Clients connect to one vMCP URL instead of multiple | ||
| proxy endpoints | ||
| - **Centralized authentication**: vMCP handles client authentication; remote | ||
| proxies validate the forwarded tokens | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I assume we can't auth to remote servers as of yet? |
||
| - **Tool namespacing**: Tools from remote proxies are automatically prefixed to | ||
| avoid conflicts with local MCP servers | ||
| - **Unified toolset**: Combine tools from container-based servers and external | ||
| SaaS MCP services | ||
|
|
||
| ### Complete example | ||
|
|
||
| This example creates a vMCP that aggregates a local Fetch server with a remote | ||
| analytics proxy: | ||
|
|
||
| ```yaml | ||
| # 1. Create the group | ||
| apiVersion: toolhive.stacklok.dev/v1alpha1 | ||
| kind: MCPGroup | ||
| metadata: | ||
| name: dev-tools | ||
| namespace: toolhive-system | ||
| spec: | ||
| description: Development tools group | ||
| --- | ||
| # 2. Local MCP Server | ||
| apiVersion: toolhive.stacklok.dev/v1alpha1 | ||
| kind: MCPServer | ||
| metadata: | ||
| name: fetch | ||
| namespace: toolhive-system | ||
| spec: | ||
| groupRef: dev-tools | ||
| image: ghcr.io/stackloklabs/gofetch/server | ||
| transport: streamable-http | ||
| --- | ||
| # 3. Remote MCP Proxy | ||
| apiVersion: toolhive.stacklok.dev/v1alpha1 | ||
| kind: MCPRemoteProxy | ||
| metadata: | ||
| name: analytics-proxy | ||
| namespace: toolhive-system | ||
| spec: | ||
| groupRef: dev-tools | ||
| remoteURL: https://mcp.analytics.example.com | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. could we use a real MCP server in the example? |
||
| transport: streamable-http | ||
| port: 8080 | ||
| oidcConfig: | ||
| type: inline | ||
| inline: | ||
| issuer: https://auth.company.com | ||
| audience: analytics-proxy | ||
| --- | ||
| # 4. Virtual MCP Server | ||
| apiVersion: toolhive.stacklok.dev/v1alpha1 | ||
| kind: VirtualMCPServer | ||
| metadata: | ||
| name: dev-vmcp | ||
| namespace: toolhive-system | ||
| spec: | ||
| groupRef: | ||
| name: dev-tools | ||
| incomingAuth: | ||
| type: oidc | ||
| oidcConfig: | ||
| type: inline | ||
| inline: | ||
| issuer: https://auth.company.com | ||
| audience: dev-vmcp | ||
| ``` | ||
|
|
||
| Clients connect to the VirtualMCPServer endpoint and see tools from both the | ||
| local Fetch server and the remote analytics proxy. | ||
|
|
||
| See [Configure vMCP servers](../guides-vmcp/configuration.mdx) for more vMCP | ||
| configuration options. | ||
|
|
||
| ## Next steps | ||
|
|
||
| See the [Client compatibility](../reference/client-compatibility.mdx) reference | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.