-
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
Open
amirejaz
wants to merge
2
commits into
main
Choose a base branch
from
vmcp-remote-server-support
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+214
−24
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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: | ||
| 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 | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The 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?