Get local issue timeline

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

Annotations already indicate readOnlyHint=true and destructiveHint=false. The description adds context by specifying the data source ('from the local SQLite database'), which provides useful behavioral information beyond annotations. It agrees with the read-only nature.

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 a single sentence that is front-loaded with the key action and resource. Every word is necessary, and there is no redundancy.

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 has one parameter and an output schema (not shown), the description adequately covers the purpose and data source. It does not need to explain return values. Minor gaps in parameter details are compensated by the parameter name and schema constraints.

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 0%, so the description should explain parameter meaning. However, it provides no details about the 'issue_id' parameter, its format, pattern, or length constraints. The parameter name is self-explanatory but insufficient for clarity on constraints.

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 diagnostic issue timeline from a local SQLite database. The verb 'Read' specifies the action, and 'diagnostic issue timeline' identifies the resource. It distinguishes from sibling tools like 'obd_list_vehicles' and 'obd_read_dtcs'.

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 the tool is for reading an issue timeline but provides no explicit guidance on when to use it versus alternatives like 'obd_read_dtcs' or 'obd_read_ecu_snapshot'. No exclusions or prerequisites are mentioned.

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