Skip to main content
Glama

set_ws_passthrough

Idempotent

Opt a tunnel into WebSocket passthrough, so an application-level WebSocket connection (e.g. a mobile/web app's own realtime feature) can be relayed to your localhost. Pro/Team plan required to enable; pass enabled: false to disable on any plan.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "subdomain": "<subdomain>",
      "enabled": "<enabled>"
    },
    "name": "set_ws_passthrough"
  }
}

Input Schema

NameRequiredDescriptionDefault
enabledYestrue to relay WebSocket connections to localhost (Pro/Team), false to turn it off.
subdomainYesTunnel subdomain, from list_tunnels, e.g. myapp for https://myapp.t.pipehero.app.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / properties / enabled / description
      Added value: +"true to relay WebSocket connections to localhost (Pro/Team), false to turn it off."
    • addedInput schema / properties / subdomain / description
      Added value: +"Tunnel subdomain, from list_tunnels, e.g. myapp for https://myapp.t.pipehero.app."
  2. Added

TDQS

A4.4/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The description adds important behavior beyond the annotations: enabling requires a Pro/Team plan, disabling is allowed on any plan, and the real effect is relaying application-level WebSocket traffic to localhost. It does not explain whether changes take effect immediately or how errors are surfaced, but it adds meaningful context.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences, front-loaded with the main action and followed by the plan/disable rule. There is no filler or redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a two-parameter toggle with no output schema, the description covers the core effect, plan gating, and reversal path. It could say more about immediate effect or prerequisites, but the essential information for correct invocation is present.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3. The description still adds semantic nuance around the enabled parameter, clarifying plan-gated enabling versus disabling on any plan, which is useful beyond the schema wording.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific action and target: opting a tunnel into WebSocket passthrough so an application-level WebSocket connection can be relayed to localhost. It distinguishes the tool from sibling tunnel operations by describing the exact toggle behavior rather than general tunnel management.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It clearly indicates when to use it for relaying WebSocket connections and states the plan requirement for enabling, plus that disabling works on any plan. It does not explicitly name alternative tools, but the context is strong enough for correct selection.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.