Telnet Console: Connect

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

The description explicitly discloses side effects ('Opening the socket is a side effect (displaces other clients), so this is not read-only'), which reinforces the readOnlyHint=false annotation. It also details the idempotent return shape and the requirement to call before logs accumulate, adding behavioral context beyond the 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?

The description is dense but efficient. It front-loads the core purpose, then covers idempotency, sequencing, and side effects in a logical order. Every sentence adds necessary information without redundancy, achieving high information density without verbosity.

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 is complete for a connection tool with no output schema. It explains the return value for the idempotent case, the subsequent polling step, and the side effect of displacing other clients. Given the tool's complexity and the lack of an output schema, the description covers all the agent needs to know to call it correctly.

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 input schema already describes the optional 'device' parameter with a clear description ('Optional target device (IP or serial). Omit to use the focused tab.'). The description does not add further semantic detail about the parameter beyond what the schema provides, so the baseline 3 applies with 100% schema coverage.

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 states the exact verb and resource: 'Open the BrightScript debug console (TCP 8085) for the targeted device', explicitly likening it to the Connect button. It distinguishes from siblings like telnet_disconnect and get_telnet_log by its role and sequencing.

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 gives explicit usage guidance: it must be called before lines accumulate, and after successful return the agent should poll with get_telnet_log. It also warns about the single-client nature that can displace other clients, implying when to avoid use (e.g., if another session is needed) and clarifies idempotent behavior.

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