tally_list_write_log

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

Annotations declare readOnlyHint=true and openWorldHint=false; the description adds that it reads a local file only and does not contact TallyPrime. It also enumerates return outcomes (WRITTEN, REJECTED, UNEXPECTED_CHANGE, OUTCOME_UNKNOWN), mentions problems, read-back, and undo fields, and explains includeXml's effect.

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?

Front-loaded purpose followed by WHEN TO USE, RETURNS, and a concise scope note. The headings make it scannable and every sentence contributes actionable context without padding.

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?

With no output schema, the RETURNS section carries return-value detail, including outcome values and the includeXml toggle. Combined with full input schema coverage and annotation safety hints, an agent has enough information to select and invoke the tool correctly.

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 limit and includeXml are already documented. The description adds meaning for includeXml by explaining that the exact XML sent and TallyPrime's reply are included, and implies newest-first ordering; limit itself gains no additional semantic detail beyond the schema.

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?

States a specific verb and resource: listing changes this server has written to TallyPrime, newest first. It distinguishes itself from sibling query/report tools by saying 'this server has written' and 'Reads a local file only; does not contact TallyPrime'. An agent can identify the tool's scope without opening the schema.

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?

Explicit WHEN TO USE section gives three concrete scenarios: answering what changed, re-preparing after a failed or timed-out confirm, and finding how to undo a change. It does not state when not to use it or name alternative tools such as tally_get_confirmation_list, so it stops short of full routing guidance.

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