Get Pipeline Step Logs

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

Annotations declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, which align with a read operation. The description adds no further behavioral traits but does not contradict annotations. A 3 is appropriate as the description is consistent but uninformative beyond the schema and 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 short and front-loaded with the purpose. The Args list is structured but somewhat redundant given the schema. Still, it is clear and without unnecessary verbiage.

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 tool has 4 parameters (3 required) and an output schema (though not detailed). The description explains the return type ('Step logs as string') but lacks details on log format, error handling, or size limits. For a simple retrieval tool, this is adequate but not comprehensive.

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%. The description lists parameters in an Args section but only adds minimal context for workspace ('optional, defaults to configured workspace'). The other parameters (repo_slug, pipeline_uuid, step_uuid) have no additional explanation, providing little value beyond the schema.

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 logs for a specific pipeline step.' It specifies the verb (Get) and resource (logs for a pipeline step), and is distinct from sibling tools which cover pull requests, issues, etc.

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. While the parameter list is provided, there is no mention of when not to use it or how it differs from similar pipeline tools like get_pipeline_steps.

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