Toggle Edit Mode

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

Discloses UI-only nature (does not modify file contents), no-op condition, return format with mode, and error on plugin unreachable. Adds context beyond annotations: 'Not affected by vault.select'. 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?

Description is concise: a few sentences with purpose, behavior, usage guideline, and example. No redundant information. Front-loaded with the core action.

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?

Given zero parameters, presence of output schema, and annotations, the description covers all necessary aspects: purpose, behavior, return value, error condition, and usage scenario. No missing elements.

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 in schema (0 params, 100% coverage). Description explicitly says 'Takes no arguments' and provides example. Baseline 4 is appropriate as the description adds clarity but doesn't need to explain params.

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?

Description clearly states the verb 'Flip', the resource 'active file in Obsidian', and the specific modes 'edit (source) mode and preview (reading) mode'. It distinguishes from siblings like workspace.openFile and notes.edit by focusing on mode toggling only.

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 a specific use case: 'when an agent has finished a multi-step edit and wants the user to see the rendered result'. Also notes it's a no-op when no file is active. Does not explicitly mention alternatives, but the simple toggle nature and sibling list show no similar tools.

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