List Project Equipment Maintenance Logs

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

Annotations already indicate readOnlyHint=true, destructiveHint=false. The description adds concrete behavioral details: paginated JSON array, pagination metadata, and the full API endpoint. This goes beyond mere safety hints to describe the response format and usage pattern.

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?

Four sentences, front-loaded with purpose, no redundant information. Every sentence adds value: purpose, usage guidance, response format, parameter details, and API reference.

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 tool's simplicity (list with 3 params, no output schema), the description covers all necessary aspects: what it returns, how to control pagination, required parameters, and even the API endpoint and domain for context. No gaps.

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 description coverage is 100% (3 params all described). The description adds value by explaining the intent of page and per_page ('control pagination') and reiterates required project_id. This clarifies the practical use of parameters beyond their schema definitions.

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 explicitly states 'Return a list of all Equipment Maintenance Logs' and specifies 'Field Productivity records', clearly distinguishing the resource and action from sibling tools like 'list_all_equipment_maintenance_records_company' or 'list_equipment_maintenance_logs' which might have different scopes.

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?

Provides explicit instructions on when to use: 'to enumerate Field Productivity records when you need a paginated overview, to find IDs, or to filter by query parameters.' It does not include when-not or alternatives, but for a list tool these exclusions are less critical.

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