Write note

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

The description explains the main effect (create/overwrite) and return value, but does not disclose potential side effects like overwrite being destructive, prerequisites, or error conditions. With no annotations, more detail would be beneficial.

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 concise sentences that front-load the purpose and include the return value. No unnecessary words.

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 tool with 3 parameters and no output schema, the description is brief. It covers the main action but leaves projectId unexplained and does not elaborate on overwrite behavior. Sibling tools provide context, but more detail on edge cases would help.

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 adds context to path and content parameters by stating they are for a note. However, the projectId parameter lacks both schema description and tool description coverage, leaving its purpose unclear.

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 verb ('Create' and 'overwrite'), the resource ('text note'), and the location ('vault path'). This distinguishes it from sibling tools like delete_note or read_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?

No explicit guidance on when to use this tool vs alternatives is given. It implies use for writing notes, but does not mention when to use other tools like move_note or list_notes.

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