post-crm-v3-objects-objtype-batch-read_read

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

With no annotations, the description carries full burden. 'Read' implies non-destructive behavior, and the example clarifies request format. However, it does not disclose response structure, pagination, rate limits, or error behavior.

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 brief and front-loaded with the core action, followed by a clear requirement and a concrete example. Every sentence earns its place without unnecessary verbosity.

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 description gives sufficient information to invoke the tool in the basic case, but with no output schema it omits return value details. It also does not explain when to use idProperty or how to request history, leaving some gaps for non-standard usage.

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 covers all parameters with descriptions (100% coverage), but many are generic. The description's example provides concrete values and structure, adding meaning beyond the schema, though it does not explain idProperty or propertiesWithHistory distinctions.

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 reads a batch of objects by internal ID or unique property values, using a specific verb and resource. It distinguishes from single-object reads and other batch reads by emphasizing 'batch' and including a concrete example.

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 when to use (batch read) and explicitly requires a body parameter, but it does not contrast with alternatives like single-object retrieval or search endpoints. No exclusions or alternate tool names are given.

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