Skip to main content
Glama
Sign In
vm-relay

vm-relay

by WeZZard
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

Resolve console status

relay_console_resolve
Read-onlyIdempotent

Refresh a guest's console-viewing status to resolve uncertain attempts without replaying them; read-only, never recovers ownership.

Instructions

Refresh this session's non-secret console-viewing status for the lease of the guest that guest names. Read-only, and it never recovers ownership. A ready status means guest preflight only, not that a viewer launched: console operations carry no screenshots and never establish authentication, displayed pixels or a human's confirmation. On macOS, viewing requires the human to choose Standard sharing of the existing console, not a new Log In session or a High Performance display, and the relay never auto-confirms that choice; server_enforced_view_only: false and an unverified viewer selection remain limitations even once transport connects. Never replay an uncertain attempt: resolve it here, or close it with relay_console_cancel.

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": {
      "guest": "<guest>"
    },
    "name": "relay_console_resolve"
  }
}

Input Schema

NameRequiredDescriptionDefault
guestYesThe guest this call acts on: the name relay_acquire answered.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.15.0
    • addedInput schema / properties / guest
      Added value: +{
+  "description": "The guest this call acts on: the name relay_acquire answered.",
+  "pattern": "^[a-z0-9][a-z0-9-]{0,47}$",
+  "type": "string"
+}
    • addedInput schema / required
      Added value: +[
+  "guest"
+]
  2. Addedv0.5.1

TDQS

A4.3/5.0
Behavior5/5

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

Annotations cover the safety profile (readOnly, idempotent, non-destructive), and the description goes well beyond them: it explains that 'ready' means guest preflight only, that no screenshots/authentication/pixels are delivered, that ownership is never recovered, and details macOS sharing-mode constraints plus the server_enforced_view_only caveat. This is exactly the operational context an agent needs.

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?

Purpose is front-loaded and each following sentence adds a distinct caveat rather than padding. The paragraph is dense and long, but the content is substantive rather than repetitive.

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 tool with subtle console semantics, no output schema and a single parameter, the description supplies the behavioral and platform nuances needed to interpret status correctly. It is thorough, with only the meaning of non-'ready' status values left implicit.

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

Parameters3/5

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

There is one parameter with 100% schema description coverage, so the schema already carries the meaning ('the name relay_acquire answered'). The description adds only that the guest names the lease, a marginal gain, which matches the baseline 3 for high-coverage schemas.

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 first sentence states a specific verb and resource: refresh this session's non-secret console-viewing status for the lease of the named guest. It is clearly distinguishable from relay_console_cancel, which it names as the contrasting operation for closing an attempt.

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 gives an explicit condition for use and an alternative: 'Never replay an uncertain attempt: resolve it here, or close it with relay_console_cancel.' That is clear routing between two siblings, though it does not compare against relay_status or relay_console_open.

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

Deploy Server

Other Tools