get_runs

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

No annotations are provided, so the description bears full responsibility for behavioral disclosure. It states the tool gets runs with formatting, implying a read operation, but does not explicitly confirm it is non-destructive or discuss error handling (e.g., invalid para_id). Missing details on side effects or permission requirements.

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 two sentences plus an arg line, front-loading the purpose. It is efficient but could be slightly more structured (e.g., using a list or clearer separation). Still, every sentence adds value.

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 tool's simplicity (one required param) and existence of an output schema, the description is minimally adequate. It mentions formatting properties but does not elaborate on what they include (e.g., font, color). It covers the basics but lacks completeness for a more complex agent.

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 description coverage is 0%, so the description must add value. It explains 'para_id: paraId of the target paragraph,' which provides context beyond the schema's type-only definition. However, it does not detail how to obtain or format the paraId, leaving some ambiguity.

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 'Get all runs in a paragraph with their formatting properties,' specifying the verb, resource, and added detail about formatting properties. This distinguishes it from sibling tools like get_paragraph or get_paragraph_format, though it doesn't explicitly differentiate from potential get_run tools. The purpose is well-defined.

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 guidance is provided on when to use this tool versus alternatives. For instance, if one wants runs without formatting, get_body_text might be more appropriate. The description lacks context on prerequisites or exclusions, leaving the agent to infer usage.

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