doc_batch_opd_note

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

With no annotations, the description discloses the operation's slow nature and built-in protections (delays, error handling, pauses), providing useful behavioral context beyond the schema.

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 succinctly organized into Args, Returns, and Protection sections, presenting all key information without any filler.

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?

It covers purpose, key params, return fields, and operational safeguards, but lacks explanations for the required auth credentials and the overall response structure, which is important given no output schema.

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 description explains formats and defaults for date_start, date_end, limit, and target_depts, but omits the required eip_id and eip_password, and gives a default for date_end that conflicts with the schema's empty string.

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 it batch retrieves outpatient SOAP notes and lists the returned fields (S, O, P, soap, drugs), distinguishing it from single-note tools like patient_opd_note.

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 usage for batch retrieval via its name and time-consuming warning, but does not explicitly state when to use this tool over alternatives or provide exclusions.

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