read_runtime_console

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

No annotations are provided, so the description carries the full behavioral burden. It discloses the key limitation that the endpoint cannot retrieve the Host Panel Console, which is important context, but does not cover permissions, side effects, or what happens when error_text is empty.

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?

Two sentences with no filler: the first states the purpose and the second provides context and an alternative. The description is front-loaded and appropriately sized.

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?

An output schema exists, so return values need not be explained. The description covers the central limitation and alternative tool, but leaves some gaps around empty error_text behavior and whether any authentication or side-effect considerations apply. For a simple optional-parameter tool, this is mostly complete.

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?

There is one optional parameter with 0% schema description coverage. The description identifies it as pasted error text for analysis, adding meaning beyond the bare schema, but does not explain default-empty behavior, format expectations, or requiredness.

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?

States specific actions: report console-access availability and analyze user-supplied console text. The context clarifies the current Code Sync endpoint cannot retrieve the Host Panel Console, distinguishing it from create_event_trace, but the name read_runtime_console still implies retrieval and the description does not differentiate from all other siblings.

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?

Gives a clear usage path: pass pasted error text for analysis or use create_event_trace for manual tracing. This names an alternative and the condition that selects it, though it does not state explicit when-not rules beyond the missing console retrieval.

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