post-crm-v4-objects-objtype-batch-read_read

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

No annotations are provided, so the description carries the full burden. It discloses the read-only nature via 'Read' and the required request body structure. However, it does not address authentication needs, batch size limits, error handling, or the response format—key behavioral aspects an agent would need to know.

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 concise, with two sentences and an illustrative example. It front-loads the purpose and includes only necessary details about the required body structure. No filler or redundant 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?

Given the absence of annotations and output schema, the description should explain return values and edge cases, but it does not. The example covers a common batch read, but omits response format, `idProperty` usage details, and behavior when IDs are invalid or properties are not found. This is a significant gap for complete agent guidance.

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 schema descriptions are generic and partially misleading (e.g., properties described as 'Key-value pairs for setting properties for the new object'). The description clarifies that `properties` are 'properties to retrieve' and provides a JSON example mapping `inputs`, `properties`, and `propertiesWithHistory`, adding significant meaning beyond the schema. It does not fully explain `idProperty`, but the overall clarification is valuable.

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: 'Read a batch of objects by internal ID, or unique property values.' This specifies the verb, resource, and retrieval modes. However, it does not explicitly distinguish this tool from sibling batch-read tools (e.g., v3 objects, associations) beyond the tool name.

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 provides practical usage context by noting 'REQUIRES body parameter' and including a concrete example. The word 'batch' implies use for multiple objects, but there is no explicit guidance on when to choose this tool over single-object get endpoints or other batch-read variants, nor are there exclusions or prerequisites stated.

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