@mcp-b/webmcp-local-relay connects WebMCP tools running in browser tabs to desktop MCP clients (Claude Desktop, Cursor, Claude Code, Windsurf) via a localhost WebSocket relay and stdio transport.
Architecture
| Layer | Description |
|---|---|
LocalRelayMcpServer | MCP server exposing static and dynamic tools over stdio |
RelayBridgeServer | WebSocket server managing browser connections and routing calls |
| Widget iframe | Hidden iframe injected by embed.js into the host page |
| Host page | The webpage with WebMCP tools registered on navigator.modelContext |
Installation
Add this JSON block to your MCP client configuration:.mcpb bundle file is available from GitHub Releases for Claude Desktop (double-click to install).
Minimal example
CLI options
Static management tools
The relay always exposes four management tools:| Tool | Description |
|---|---|
webmcp_list_sources | Lists connected browser tabs with metadata: tab ID, origin, URL, title, icon, tool count |
webmcp_list_tools | Lists all relayed tools with source info |
webmcp_call_tool | Invokes a relayed tool by name with JSON arguments (for clients that do not support dynamic tool registration) |
webmcp_open_page | Opens a URL in the default browser or refreshes a connected source page by matching origin |
Dynamic tool registration
Tools registered on webpages are forwarded to the MCP server as first-class tools. Tool names are sanitized to the character set[a-zA-Z0-9_].
When multiple tabs register a tool with the same name, a short tab-ID suffix disambiguates them:
| Situation | Tool name |
|---|---|
| Single provider | get_issue |
| Multiple providers | search_ed93, search_a1b2 |
Browser embed
Add a script tag to expose a page’s WebMCP tools to the relay:navigator.modelContext, they are picked up automatically.
Embed attributes
| Attribute | Default | Description |
|---|---|---|
data-relay-host | 127.0.0.1 | Relay WebSocket host |
data-relay-port | 9333 | Relay WebSocket port |
data-relay-id | (none) | Filter relays during discovery by stable relay identifier |
data-relay-workspace | (none) | Filter relays during discovery by workspace name |
data-request-timeout | 60000 | Per-request timeout in milliseconds |
data-auto-connect | true | Start discovery immediately — set to "false" to defer until an explicit webmcp.connect message |
data-debug | (none) | Add this attribute (with no value) to enable diagnostic logging in the browser console |
localhost. Tools are discovered via navigator.modelContext (or navigator.modelContextTesting as fallback) and forwarded to the relay.
Elicitation support
When the page’s model context exposesnavigator.modelContext.elicitInput, the embed installs an elicitation bridge. Elicitation requests from browser tool handlers are forwarded through the relay widget iframe to the local relay server, which then forwards them to the connected MCP client (for example, Claude Code). Responses travel the same path back to the originating tool. The bridge is installed automatically before each tool invocation and only when elicitInput is present.
Reconnection and client mode
The widget reconnects automatically using exponential backoff (1.5x multiplier) from500ms up to 3000ms, stopping after 100 attempts.
Port range discovery and browser probing: The server tries ports 9333–9348 instead of failing on a single port. The chosen port is persisted to ~/.webmcp/relay-port.json for stable restarts. The widget probes the port range sequentially with a state machine (connected → retry-same-endpoint → rediscover) and caches discovered endpoints in sessionStorage.
Subprotocol handshake: WebSocket connections negotiate webmcp.v1 as the primary subprotocol and webmcp-discovery.v1 for discovery probes. On connect, the server sends a server-hello message containing the relay’s identity: instanceId, host, port, and optional label, workspace, and relayId. The browser responds with a hello message carrying tabId, origin, title, and url. The server completes the handshake with hello/accepted.
Heartbeat: The relay server pings connected sources every 15 seconds. Connections are closed after 25 seconds with no response, enabling fast rediscovery after ungraceful relay shutdowns.
Multi-relay selection: Use data-relay-id and data-relay-workspace embed attributes to filter relays during discovery. Only relays whose server-hello identity matches the configured filters are accepted.
When a second relay instance starts and the port is in use (EADDRINUSE), it falls back to client mode. In client mode the relay connects as a WebSocket client to the existing server relay and proxies tool operations through it. If the server relay stops, the client promotes itself back to server mode after a reconnection cycle. This lets multiple MCP clients share the same browser connections.
Runtime compatibility
The relay supports pages using:@mcp-b/global(recommended)@mcp-b/webmcp-polyfillwithnavigator.modelContextTesting
navigator.modelContext.listTools + callTool when present, and falls back to navigator.modelContextTesting.listTools + executeTool.
Security
- Binds to
127.0.0.1by default (loopback only). - Default
allowedOriginsis*, permitting any browser page to connect. Use--widget-originto restrict which host page origins can register tools. --widget-originvalidates the host page origin reported in the browserhellomessage, not the iframe origin.- Any local process can connect regardless of origin restrictions.
Exported API
The package exports the following for programmatic use:| Export | Kind | Description |
|---|---|---|
LocalRelayMcpServer | Class | MCP server with stdio transport and dynamic tool sync |
LocalRelayMcpServerOptions | Type | Construction options |
RelayBridgeServer | Class | WebSocket relay managing browser connections |
RelayBridgeServerOptions | Type | Bridge server options |
RelayRegistry | Class | Multi-source tool aggregation and deduplication |
AggregatedTool | Type | A tool resolved across multiple sources |
SourceInfo | Type | Metadata about a connected browser tab |
ResolvedInvocation | Type | In-flight tool call resolution state |
HelloRequiredError | Class | Thrown when hello handshake is missing |
sanitizeName | Function | Sanitizes a tool name to [a-zA-Z0-9_] |
buildPublicToolName | Function | Builds a disambiguated public tool name |
extractSanitizedDomain | Function | Extracts and sanitizes domain from a URL |
parseCliOptions | Function | Parses CLI arguments |
printHelp | Function | Prints CLI usage to stderr |
CliOptions | Type | Parsed CLI option shape |
./protocol:
| Export | Kind | Description |
|---|---|---|
ToolSchema | Zod schema | Validates a tool descriptor |
InboundToolSchema | Zod schema | Validates an incoming tool from the browser |
NormalizedToolSchema | Zod schema | Normalized tool shape after processing |
CallToolResultSchema | Zod schema | Validates a tool execution result |
CallToolRequestParamsSchema | Zod schema | Validates call-tool request params |
ToolAnnotationsSchema | Zod schema | Validates tool annotation hints |
RelayInvokeArgsSchema | Zod schema | Validates relayed invocation arguments |
DEFAULT_TOOL_INPUT_SCHEMA | const | Default { type: 'object', properties: {} } |
normalizeInboundTool | Function | Normalizes a raw inbound tool descriptor |
RelayTool | Type | Normalized relay-side tool shape |
RelayCallToolResult | Type | Result type for a relayed tool call |
RelayToolAnnotations | Type | Annotation hints for relayed tools |
RelayInvokeArgs | Type | Type for RelayInvokeArgsSchema output |
| Export | Kind |
|---|---|
BrowserToRelayMessage / BrowserToRelayMessageSchema | Type + Zod |
RelayToBrowserMessage / RelayToBrowserMessageSchema | Type + Zod |
RelayClientToServerMessage / RelayClientToServerMessageSchema | Type + Zod |
RelayServerToClientMessage / RelayServerToClientMessageSchema | Type + Zod |
ServerHelloMessage / ServerHelloMessageSchema | Type + Zod |
RelayHelloAcceptedMessage / RelayHelloAcceptedMessageSchema | Type + Zod |
RelayHelloRejectedMessage / RelayHelloRejectedMessageSchema | Type + Zod |
RelayDescriptor / RelayDescriptorSchema | Type + Zod |
RelaySourceInfo / RelaySourceInfoSchema | Type + Zod |
Troubleshooting
| Problem | Fix |
|---|---|
No sources connected | Ensure the page loaded embed.js and the relay process is running |
No tools listed | Ensure tools are registered on the page’s WebMCP runtime. If tools register after load, confirm your runtime emits tool-change notifications (toolschanged or registerToolsChangedCallback) |
Tool not found | Tab reloaded or disconnected — call webmcp_list_tools again to refresh |
| Connection blocked | Verify --widget-origin matches your host page’s origin (e.g., https://myapp.com), and relay port matches data-relay-port |
Host response timeout: | The host page took longer than the per-request timeout (default 60s) to respond. Increase via data-request-timeout="<ms>" on the embed script tag |
Related
- Connect Desktop Agents with Local Relay (how-to guide)
- Desktop Agent Relay (tutorial)
- @mcp-b/global (runtime reference)
- Transports and Bridges (explanation)
