List BIM Model Change History

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

Annotations already state readOnlyHint, destructiveHint, idempotentHint, and openWorldHint. The description adds behavioral details: sorting order (most recent first), pagination behavior, required parameters, and endpoint information. This complements annotations without contradiction.

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 five sentences, each adding distinct information: deprecation notice, core functionality, sorting, usage context, pagination guidance, and required parameters. No redundant or unnecessary text.

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 parameter count (5) and no output schema, the description covers purpose, pagination, required parameters, and endpoint details. It lacks detailed return value structure but the 'paginated JSON array of BIM records' is sufficient for a list operation.

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 coverage is 100%, so the baseline is 3. The description adds value by explaining pagination usage ('Use page and per_page to control pagination; the response includes pagination metadata') and listing required parameters (id, project_id), which goes beyond the schema's basic descriptions.

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 states the tool returns change history for a specified BimModel, sorted by most recent first. It explicitly mentions enumerating BIM records, finding IDs, and filtering by query parameters, which clearly defines the purpose and distinguishes it from similar tools like listing BIM models.

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 indicates when to use: for paginated overview, finding IDs, or filtering. It also notes the endpoint is deprecated, implying a newer alternative might exist, but does not explicitly provide an alternative or when not to use. This is clear context but lacks exclusion guidance.

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