Export network docs to the vault

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

Annotations indicate readOnlyHint=false and destructiveHint=false. The description adds the prerequisite environment variable TDMCP_VAULT_PATH and describes the output format, giving useful behavioral context beyond annotations. However, it doesn't specify whether existing notes are overwritten or merged.

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 a single, well-structured sentence that efficiently conveys the tool's purpose and output, followed by a necessary requirement. No wasted 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 three optional parameters and no output schema, the description sufficiently covers what the tool does and its output format. Missing details like error handling or permissions are minor given the simplicity.

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?

All three parameters have descriptions in the input schema, so the description adds no new meaning beyond what the schema provides. The baseline of 3 is appropriate given 100% schema coverage.

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 tool exports a TD network as an Obsidian note with a Mermaid flowchart and wikilinks, making the vault's graph view clickable. This distinguishes it from siblings like 'save_recipe_to_vault' and 'document_network'.

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 implies usage for documenting a network into the vault but does not explicitly say when to use it versus alternatives or when not to use it. Requirements like TDMCP_VAULT_PATH are mentioned but context for choosing this tool is minimal.

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