Skip to main content
Glama

check_relay_status

Check if the user currently has an active Local Webhook Relay session (WebSocket tunnel) running. ALWAYS call this tool before setting webhookUrl on any mock if the user is working locally or might want local delivery. If active is true, you can use the 'simceptor://local/' URL scheme to deliver webhooks directly to their local server. If active is false: NEVER generate or read the required Personal Access Token yourself — it must come from the user, who generates it from their dashboard ('Developer Keys', with the 'Local Webhook Relayer' scope). Once they share that token with you, how you proceed depends on whether you have direct local shell/terminal execution access on the SAME machine the user is developing on (e.g. Claude Code): if you do, you may run npx @simceptor/cli listen --token <PAT> --to http://localhost:<port> yourself — but first tell the user this opens a persistent background network tunnel from Simceptor's cloud to their machine, and how to stop it (the process can simply be killed) when they're done. If you do NOT have local shell access (e.g. a hosted/remote connector like the claude.ai web app), you cannot run this on the user's machine at all — instruct them to run the command in their own terminal instead, then call this tool again to confirm the session shows active.

Input Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.8/5.0
Behavior5/5

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

No annotations exist, so the description carries the full behavioral burden and largely meets it: it discloses that a false result requires a user-supplied PAT with the 'Local Webhook Relayer' scope, forbids the agent from generating or reading the token itself, and warns that running the CLI opens a persistent background tunnel that must be manually killed. It also implies the return carries an 'active' boolean, which is the only output the agent needs to branch on.

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

Conciseness4/5

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

Front-loaded with the purpose, then the mandatory precondition, then outcome-specific instructions — a sensible ordering. It runs long and drifts into operational detail (the npx command line, dashboard navigation path) that could be trimmed, but each sentence does influence the agent's next action rather than padding.

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

Completeness5/5

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

For a no-parameter status check with no output schema and no annotations, the description supplies everything an agent needs: when to call it, what each result means, the URL scheme to use on success, and the full remediation path plus safety disclosure on failure. Nothing material is left for the agent to guess.

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?

The tool takes zero parameters, so there is no parameter semantics to explain — the baseline for a 0-param tool. The description correctly adds nothing spurious about inputs and keeps focus on the outcome.

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?

States a specific verb and resource — checking whether an active Local Webhook Relay session (WebSocket tunnel) exists — and immediately ties it to its only relevant sibling action, setting webhookUrl on a mock. No other tool in the sibling list touches relay/tunnel state, so the distinction is unambiguous.

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

Usage Guidelines5/5

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

Explicit routing rule: 'ALWAYS call this tool before setting webhookUrl on any mock if the user is working locally or might want local delivery.' It then branches on both outcomes (active=true → use simceptor://local/<path>; active=false → PAT flow), including the sub-branch for shell access vs. hosted connector. This is about as close to a decision tree as a tool description gets.

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.

Resources