get_pipeline_history

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

With no annotations provided, the description clearly indicates a read operation (get execution history) and explains it provides diff analysis. It lists parameters and a returns summary. However, it does not mention any side effects, required permissions, rate limits, or error cases, which would make it fully transparent.

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 very concise: a two-line summary followed by structured Args/Returns sections. Every sentence adds value (purpose, diff analysis, parameter explanations, return fields). No redundant or irrelevant information.

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 sibling tools (list_pipelines, manage_pipeline, etc.), the description clearly defines this tool's role: historical execution data with diff analysis. An output schema exists (indicated by context signals), and the description lists key return fields. However, it does not explain how 'diff analysis' determines new/removed articles, which could be helpful for an agent deciding between tools.

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 compensate. It explicitly describes both parameters: 'name' as the pipeline name and 'limit' with its default value of 5. This adds meaning beyond the type and required fields, though it could clarify if 'limit' is a strict maximum or optional.

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 begins with a clear action and resource: 'Get execution history for a saved pipeline.' It further specifies the unique value of 'diff analysis' (new/removed articles), which distinguishes it from sibling tools like list_pipelines, manage_pipeline, or delete_pipeline.

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 viewing history with diff analysis, but does not explicitly state when to use this tool versus alternatives. For example, it doesn't mention that list_pipelines only lists names, not history, or that manage_pipeline is for editing. No exclusions or when-not-to-use guidance is provided.

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