-
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
Changes from all commits
11a65a9
9d9a221
48ba983
e990ffc
f4ef0bb
d2e82ce
cf80589
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,66 @@ 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 discovered by a | ||
| VirtualMCPServer, enabling you to combine remote MCP servers with local | ||
| container-based MCPServer resources into a single unified endpoint. | ||
|
|
||
| :::caution[Current limitation] | ||
|
|
||
| vMCP can discover MCPRemoteProxy backends in a group, but authentication between | ||
| vMCP and MCPRemoteProxy is not yet fully implemented. Since MCPRemoteProxy | ||
| requires `oidcConfig` to validate incoming requests, and vMCP does not currently | ||
| forward authentication tokens to backends, vMCP cannot communicate with | ||
| MCPRemoteProxy backends that require authentication. | ||
|
|
||
| This limitation will be addressed in a future release. For now, MCPRemoteProxy | ||
| works best when accessed directly by clients rather than through vMCP | ||
| aggregation. | ||
|
|
||
| ::: | ||
|
|
||
| ### Add remote proxy to a group | ||
|
|
||
| To include a remote proxy in an MCPGroup for future vMCP aggregation, add the | ||
| `groupRef` field to your MCPRemoteProxy spec: | ||
|
|
||
| ```yaml | ||
| apiVersion: toolhive.stacklok.dev/v1alpha1 | ||
| kind: MCPRemoteProxy | ||
| metadata: | ||
| name: context7-proxy | ||
| namespace: toolhive-system | ||
| spec: | ||
| groupRef: my-group # Reference to an MCPGroup | ||
| remoteURL: https://mcp.context7.com/mcp | ||
| 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?
Contributor
Author
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. vMCP currently does not send the token to MCPRemoteProxy as of yet. I have added the note about the authentication gap between vMCP and MCPRemoteProxy |
||
| type: inline | ||
| inline: | ||
| issuer: https://auth.company.com | ||
| audience: context7-proxy | ||
| ``` | ||
|
|
||
| ### Planned benefits of vMCP aggregation | ||
|
|
||
| When vMCP authentication to MCPRemoteProxy is implemented, the following | ||
| benefits will be available: | ||
|
|
||
| - **Unified endpoint**: Clients connect to one vMCP URL instead of multiple | ||
| proxy endpoints | ||
| - **Centralized authentication**: vMCP handles client authentication at the | ||
| entry point | ||
| - **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 | ||
|
|
||
| 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.