brc_list_nominal_journal_batches

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

Without annotations, the description should clearly state read-only nature. It says 'Returns a list' implying a read operation, but does not explicitly mention safety or absence of side effects. Additional behavioral details like pagination or rate limits are absent.

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?

Two-sentence description with no waste. First sentence states purpose, second provides use-case guidance. Front-loaded and efficient.

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?

For a list tool with 5 parameters and 100% schema coverage, the description is sufficiently complete. It explains the typical use case (identify id and timestamp before update/delete). No output schema exists, but the list's purpose is clear.

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%, so the baseline is 3. The description adds value by mentioning filter by entryDate and order by id, but these are already described in the schema. No new parameter context is provided.

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 'Returns a list of the company's Nominal Journal Batches', with a specific verb and resource. It also distinguishes itself from sibling list tools by focusing on nominal journal batches and explicitly linking to update/delete operations.

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 explicit guidance: 'Use this before updating or deleting a nominal journal batch so the user can identify the correct id and timestamp.' This tells when to use the tool, though it does not contrast with other list tools.

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