nvim_type

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

With no annotations, the description carries the full burden and does well on the core behavior: characters including $, !, and quotes are typed exactly, and the '$HOME' example clarifies no shell expansion occurs. It does not mention session prerequisites, current mode, or cursor behavior, leaving some operational context undisclosed.

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 front-loaded with the core action, followed by use cases and a concrete example. There is minor redundancy between 'without any special key interpretation' and 'typed exactly as provided,' but every sentence contributes and it stays brief.

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 simple two-parameter typing tool with no output schema, the description covers what an agent needs to invoke it correctly: literal typing, no escaping, and a clarifying example. It omits session lifecycle context (e.g., must the session already be started), which is a modest gap for this complexity level.

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 description coverage is 100%, so both parameters are already documented with newline/tab behavior and no-escaping semantics. The description adds an illustrative example but no additional semantic detail beyond what the schema provides, matching the baseline for fully covered parameters.

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 names a specific verb ('Type') and resource ('literal text') and distinguishes itself from key-sequence siblings by ruling out 'special key interpretation.' It does not explicitly name an alternative like nvim_keys, so full sibling differentiation is implied rather than stated.

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 gives clear use cases ('Perfect for code, URLs, or text with special characters') and an implicit exclusion via 'without any special key interpretation.' It stops short of naming the sibling tool to use when special keys are desired, so it lacks explicit alternatives.

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