read_console

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

With no annotations, the description fully covers behavior: it is a read-only operation, returns a PNG, can type commands first, and warns about console contention and the need to close browser tabs. No contradictions.

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?

The description is three sentences of essential information. It front-loads the main purpose and packs details efficiently without wasted words.

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?

The description covers prerequisites, usage patterns, and typical use cases. It does not detail error conditions or response format, but 'returns a PNG image' is sufficient for a straightforward read tool. No output schema exists, so more detail could help, but it is adequate.

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?

Despite 0% schema coverage, the description adds meaning by explaining the 'commands' parameter (list of lines to type). 'node_id' and 'lab_path' are left implicit but are standard and understandable from context. The description compensates well for the schema's lack of descriptions.

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 clearly states it reads a node's LIVE console as a screenshot, returning a PNG image. It explicitly distinguishes itself from send_console, which is a sibling tool for writing. Specific use cases like verifying 'show' commands are listed.

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?

The description provides explicit when-to-use guidance: for reading console output, especially after typing commands. It gives a key pattern (type+read in one call to avoid contention). Prerequisites (node must be running, close browser console tab) are stated. However, it does not explicitly state when not to use.

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