upload_package

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

The description adds 'MUTATING' and 'Async operation,' which are behavioral traits not fully captured in annotations (readOnlyHint=false, idempotentHint=false). However, 'MUTATING' is redundant with annotations, and the description omits details like authentication requirements or whether uploads overwrite or merge.

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?

Three sentences, front-loaded with purpose, then use case, then a critical usage instruction. No wasted words; every sentence earns its place.

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?

Despite good annotations and schema coverage, the description lacks essential details for an async operation: it does not explain what the tool returns (e.g., a task ID), how to track progress, or when to use polling parameters like timeoutMs and pollIntervalMs. This is a significant gap.

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?

The input schema already has 100% description coverage for all 5 parameters. The description adds minimal value beyond the schema, only referencing dryRun briefly. Baseline 3 is appropriate as schema does the heavy lifting.

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 action ('Uploads a package file') and the target resource ('Cognigy.AI project'). It also distinguishes itself from sibling tools like upload_snapshot_package by specifying 'package file' and providing use cases like importing a downloaded package or transferring resources.

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 explicitly provides use cases ('import a previously downloaded package or transfer resources between environments') and a key directive ('Set dryRun=false to upload'). It lacks explicit exclusion of when not to use or alternatives, but the context is clear enough.

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