st.chat.authors_note.set

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

With no annotations, the description must carry behavioral weight. It usefully signals a mutation ('override fields') and a non-obvious requirement ('confirm: true'). However, it does not disclose side effects on existing chat_metadata fields, behavior of force/enabled, or what happens when unspecified fields 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?

The description is one compact sentence with the main action front-loaded and no filler. Every word contributes functional guidance, and it is structured for quick parsing.

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?

An 11-parameter setter with no annotations, no output schema, and zero parameter descriptions needs far more context than a single purpose-and-precondition sentence. The description covers intent and one precondition, but leaves most parameter semantics and behavioral edge cases undefined.

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 must compensate, but it only adds semantic weight to avatar, fileName, and confirm. The other eight parameters—role, text, depth, force, enabled, interval, position, snapshotLabel—remain unexplained, leaving the low-coverage gap largely unaddressed.

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 states a clear action with object and scope: 'Set the current-chat Author's Note override fields in chat_metadata.' This distinguishes it from generic siblings like st.chat.metadata.patch by naming a specific sub-resource. It does not explicitly name alternative tools, which keeps it from a 5.

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 gives a concrete precondition ('Requires explicit avatar/fileName and confirm: true') and an explicit target, but it does not say when to prefer this over related setters such as st.chat.metadata.patch or st.chat.variables.set. The usage context is implied from the tool name rather than spelled out.

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