get_pipeline_logs

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

With no annotations, the description fully carries the burden. It discloses that the output is automatically stored, returns a formatted preview with an object ID for reference, and can be passed to other functions. No hidden side effects are omitted.

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 well-structured with a summary line, parameter list, and post-processing notes. While thorough, it could be slightly more concise without losing clarity. However, 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 complexity (4 parameters, no output schema), the description covers purpose, parameter behavior, output details (object ID and storage), and usage in debugging/monitoring. It is complete for a non-destructive data retrieval tool.

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%, but the description explains all four parameters: pipeline_name (required), limit (default 30), level (filter options with enum values detailed), and after (paginated cursor). This compensates fully for the schema gaps.

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 'Fetches logs for a specific pipeline,' which is a specific verb-resource combination. It distinguishes itself from sibling tools like 'get_latest_custom_component_installation_logs' by focusing on pipeline logs.

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 context ('useful for debugging pipeline issues or monitoring pipeline execution') but does not explicitly mention when not to use this tool or suggest alternatives. The guidance is clear but lacks exclusion criteria.

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