waitForTerminalOutput

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

The description discloses that the tool blocks execution, returns specific fields (matched, matchedLine, elapsed), and has a timeout. Annotations already set readOnlyHint=true, so the description adds the blocking behavior. However, it does not fully explain the timedOut return state or error scenarios.

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 a single sentence that front-loads the purpose and return value. Every word adds value; no wasted text.

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 no output schema, the description provides the return shape. It lacks details about timeout behavior and error conditions, but is sufficient for core functionality. The tool is simple and the description 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?

Input schema has 100% parameter description coverage, so the description adds no extra meaning beyond what is already documented in the schema. Baseline score of 3 is appropriate.

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 action ('Block until regex matches terminal output') and the resource (terminal output), and specifies the return shape. It distinguishes from siblings like getTerminalOutput (retrieves output) and sendTerminalCommand (sends command) by emphasizing blocking and pattern matching.

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?

No explicit guidance on when to use this tool versus alternatives. The description implies its use when waiting for a pattern, but does not mention when not to use it or provide alternatives. The parameter descriptions hint at using listTerminals to get name/index, but this is baseline.

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