Get Telnet / BrightScript Console Log

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

The description goes beyond the readOnlyHint and idempotentHint annotations by explicitly stating the tool is read-only and never touches the device. It also reveals important behavioral traits: lines accumulate only while connected, and the tool drains an existing buffer, with a caveat about the single-client socket.

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 concise and well-structured, using about four sentences to cover the return shape, parameters, prerequisites, and caveats. Each sentence adds essential information without redundancy or unnecessary detail.

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?

Given the sibling tools include telnet_connect and console_monitor_findings, the description clearly places this tool in context by referencing the connection requirement and the buffer mechanism. It also describes the return structure, making it sufficiently complete even without an output schema.

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?

The schema covers 100% of parameters with descriptions, and the description further enriches semantics by explaining that afterCursor is from a previous call, omitting it returns the full buffer, and maxLines has a default and maximum. This provides complete context for each parameter's purpose.

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 the tool reads lines from the BrightScript debug console buffer, specifies the resource (port 8085) and the return format, and distinguishes itself from sibling tools like telnet_connect and console_monitor_findings by focusing on reading the buffered output.

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 usage guidance: it is for polling (using afterCursor), explains how maxLines caps the response, and instructs to call telnet_connect first if the console is not connected. It also warns about the single-client limitation, giving clear conditions for correct use.

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