Write Obsidian Note

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

The description adds useful behaviors beyond annotations, such as automatic directory creation and the note metadata return. It reinforces the overwrite flag's effect. No contradiction with annotations, though it could elaborate on edge cases like permission failures.

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. The first sentence states the core purpose, followed by three short, informative sentences that add critical usage details without fluff. Every sentence earns its place.

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 write tool with 4 well-documented parameters and annotations, the description covers the essential aspects: purpose, overwrite safety, directory creation, and return value. It lacks an explicit note on when not to use it, but overall it is sufficiently complete for effective tool invocation.

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?

Since the input schema already describes all 4 parameters (100% coverage), the baseline is 3. The description adds value by explaining the 'overwrite' flag's practical impact and mentioning 'frontmatter' as optional, slightly enriching semantic understanding 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?

The description opens with 'Create or update a note in the vault,' using a specific verb and resource. This clearly distinguishes it from sibling tools like read, delete, or search, making the purpose unmistakable.

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?

It clearly indicates when to use the tool (for creating or updating notes) and provides a condition for preventing overwrites with 'Set overwrite=false.' However, it does not explicitly name alternative tools for other operations, so it stops short of full 5.

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