archive_pipeline_stage

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

With no annotations, the description carries the full burden of disclosing behavior. It simply states the action without explaining consequences (e.g., whether archiving is reversible, what happens to deals in the stage, or any required permissions).

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 extremely concise and well-structured, with a clear one-sentence purpose followed by parameter explanations. No unnecessary words or filler.

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, an output schema exists to explain return values, and the parameter list is small. However, the description omits important behavioral context (e.g., side effects, prerequisites), making it only minimally adequate.

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 adds brief parameter meanings: pipeline_id is 'The Nimble pipeline ID' and stage_id is 'The stage ID to archive.' This helps, but it lacks details on formats, constraints, or the relationship between the two parameters.

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 the tool's function: 'Archive a pipeline stage.' It uses a specific verb and resource, distinguishing it from sibling tools like archive_deal_pipeline, which archives an entire 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?

No usage context is provided. The description does not explain when to archive a stage, what prerequisites exist (e.g., stage must belong to a pipeline), or how this differs from deletion or other alternatives.

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