docs(mcp-proxy): add copy-and-run example workspace#360
Merged
Conversation
The MCP Proxy guide lacked a working, copyable example. This adds: - examples/workspaces/mcp-proxy/ — a minimal workspace that installs the deepwiki plugin (a real public HTTP MCP server at https://mcp.deepwiki.com/mcp) and proxies it to Codex via mcp-remote - A Quick Start section in docs/guides/mcp-proxy.mdx with the full workspace.yaml users can copy directly and a link to the example Verified end-to-end: running 'allagents update' against the example produces an HTTP config for Claude and a stdio config (npx mcp-remote) for Codex.
Deploying allagents with
|
| Latest commit: |
0562fca
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://a32cbe78.allagents.pages.dev |
| Branch Preview URL: | https://docs-mcp-proxy-example.allagents.pages.dev |
Scaffolding the example via 'allagents workspace init --from EntityProcess/allagents/examples/workspaces/mcp-proxy' is simpler than asking users to drop a workspace.yaml into a fresh directory, and it runs the initial sync in one step.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
The MCP Proxy guide explains how the feature works but never showed a complete, runnable example. This PR fixes that:
examples/workspaces/mcp-proxy/— a minimal workspace that installs the officialdeepwikiplugin (a real public HTTP MCP server athttps://mcp.deepwiki.com/mcp) and proxies it to Codex viamcp-remote.docs/guides/mcp-proxy.mdxwith the fullworkspace.yamlusers can copy directly, plus a link to the example directory.The example was chosen so it works end-to-end with zero setup: DeepWiki is public, no-auth, and
mcp-remoteis fetched on demand vianpx.Test plan
Green E2E verification (using a fresh temp workspace):
Observed result:
.mcp.json→ HTTP config preserved for Claude.codex/config.toml→[mcp_servers.deepwiki]withcommand = "npx"andargs = ["mcp-remote", "https://mcp.deepwiki.com/mcp", "--http", "--static-oauth-client-metadata", "@~/.allagents/mcp-remote/mcp-metadata-settings.json"]Build passes
Lint / Typecheck / Test pre-push hooks pass
Green E2E: example workspace produces correct HTTP+stdio split
CI green