Bind a Text DAT to a vault note

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

Discloses live sync behavior when sync is on. Annotations (readOnlyHint=false, destructiveHint=false, openWorldHint=true) already indicate basic safety; the description adds non-obvious timing nuance. No contradictions.

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 efficient sentences plus a requirement line. Front-loaded with purpose, 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?

Explains input, output (Text DAT), and next step (wire into Text TOP). Lacks return value details, but tool creates a node in the network, which is adequately addressed by the usage guidance.

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 already covers all 4 parameters with descriptions. The description provides minimal extra value beyond explaining the overall workflow (e.g., no new parameter constraints). Baseline 3 is appropriate.

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?

Describes a specific action: creating a Text DAT that reads from a vault note, with live sync. Clearly distinguishes from siblings like create_text_overlay by tying functionality to vault notes.

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?

States when to use (as text source from vault) and provides a step ('Wire the DAT into a Text TOP'). Mentions requirement TDMCP_VAULT_PATH. Does not explicitly contrast with alternatives, but the specialized context is sufficient.

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