Toggle Edit Mode

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

Description adds useful behavioral context: the tool toggles modes, requires a specific plugin, and is independent of vault.select. Annotations already indicate non-readonly and non-destructive, but description elaborates on the state change. No contradiction with annotations.

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?

Three short sentences, each carrying essential information: purpose, requirements, and a clarifying constraint. No 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?

Tool is simple with no parameters and an output schema present. Description covers dependencies, behavioral scope, and constraints fully. Nothing essential is missing.

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?

No parameters exist, so the parameter burden is zero. Baseline of 4 applies since description does not need to add parameter details.

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?

Clearly states the verb 'toggle', resource 'active file between edit and preview mode', and context 'Obsidian'. Unambiguous and distinct from sibling tools like workspace.openFile or workspace.navigate.

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?

Provides explicit requirement for Local REST API plugin and explains that vault.select does not affect this tool. However, it does not mention alternatives or when not to use this tool versus other workspace commands.

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