Query a live session

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint, so the safety profile is covered. The description adds useful behavioral context by framing it as a single read call, returning JSON, and deliberately limiting access to read routes only, which goes beyond the structured annotations.

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

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

Three sentences, each with a distinct job: statement of function, recommended first call, and route scope/exclusion. The route list is long but necessary because the schema lacks an enum, and no filler or redundant restatement appears.

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

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

With an output schema present and annotations covering side-effect safety, the description only needed to explain what the tool does, how to start, and which routes are valid—all provided. The only minor omission is behavior when a session isn't running, but the 'running session' qualifier and output schema make the tool callable without further documentation.

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

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

Schema descriptions cover pid, query, and route at 100%, so baseline is 3. The description adds real value for route by enumerating all allowed routes and recommending the initial route value ('agent'), which is not present as an enum in the schema.

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

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

The description opens with 'Calls one read route on a running xlide_vbide session and returns its JSON,' naming the verb, resource, and output format. It further differentiates by listing allowed read routes and explicitly excluding editor-driving routes, making the tool's scope unmistakable against sibling live-session tools.

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

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

It gives concrete usage guidance: 'Start with route="agent"' and lists allowed routes, plus states which routes are not reachable ('Routes that drive the editor are deliberately not reachable here'). It does not explicitly map to alternative sibling tools, but the exclusions and recommended starting point provide clear context for when this tool is appropriate.

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