read_macro_lines

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

No annotations are provided, so the description must disclose behavioral traits. It mentions that it retrieves and parses lines and returns a dict with parsed lines and raw response, but it does not state idempotency, side effects, permissions, or error handling. The description adds some context beyond annotations (none present) but lacks full transparency.

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 with a brief intro, structured Args section, and clear return type. Every sentence adds value without redundancy. It is appropriately front-loaded with the main purpose.

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 annotations and no output schema, the description covers purpose, parameters, and return structure. It is fairly complete for a simple read tool, though it could mention error handling or behavior when macro does not exist.

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?

Schema coverage is 0%, meaning the schema has no descriptions. The description compensates by explaining both parameters in the Args section: 'macro_id: Macro ID to read' and 'pool: Macro pool number (default 1)'. This adds full semantic meaning beyond the schema's minimal type/title info.

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 'Read macro line content for a given macro' with a specific verb (read) and resource (macro line content). It distinguishes from sibling tools like 'list_macros' (lists macro names) and 'set_macro_line' (writes lines), as it retrieves and parses all lines.

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 implies usage for reading macro content but does not explicitly state when to use versus alternatives like 'run_macro' or 'set_macro_line'. No when-not-to-use guidance or context for choosing this tool over siblings is provided.

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