update_note

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

With no annotations provided, the description fully discloses behavior: it modifies a note's properties, returns a JSON string of updated data, and raises ValueError for invalid or non-modifiable notes. This covers key aspects, though details like atomicity or side effects are omitted.

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 concise and well-structured, using clear sections for Args, Returns, Raises. Every sentence adds value without 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's simplicity and the presence of an output schema (implied), the description covers purpose, parameters, return value, and error conditions. It is fully adequate for an AI agent 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?

The description documents all three parameters (note_id required, title and text optional) with explanations of their roles, significantly adding meaning beyond the input schema's mere titles and types. Schema coverage is 0%, so the description is essential.

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 starts with 'Update a note's properties,' clearly stating the action (update) on a resource (note). This distinguishes it from sibling tools like archive_note, delete_note, etc., which have different purposes.

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 includes when the tool raises a ValueError (if note doesn't exist or cannot be modified), providing context on failure conditions. However, it does not explicitly state when to use this tool versus alternatives or specify prerequisites.

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