post-crm-v3-objects-objtype-batch-archive_archive

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

No annotations are provided, so the description must disclose side effects of archiving (e.g., reversibility, effect on associations). It only gives an example and a requirement, leaving behavioral consequences unclear.

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 primary action. The example is useful, though the wording 'REQUIRES body parameter' is somewhat awkward. No unnecessary content.

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?

With no output schema and no annotations, the description covers invocation basics but omits response format, error behavior, and what 'archive' semantically implies (e.g., vs delete or restore). Adequate for a simple tool but not fully complete.

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 descriptions are generic ('Array of items', 'string parameter'), so the example adds concrete structure for inputs. However, it doesn't clarify objectType usage, batch size limits, or error handling, and the phrase 'body parameter' is slightly ambiguous.

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?

Clearly states the action ('Archive'), the resource ('batch of objects'), and the scope ('by ID'). Distinct from siblings like delete and batch-read; unambiguous verb and resource.

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?

Implies usage context: when you need to archive multiple objects by ID. However, no explicit alternatives or exclusions are mentioned, nor comparisons to similar v4 endpoints or single-object delete.

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