Skip to main content
Glama

clear_virtual_texts

Remove MCP virtual text annotations from a Neovim buffer. Clears only annotations added by add_virtual_text or add_virtual_texts without affecting other content.

Instructions

Remove all MCP virtual text annotations from a Neovim buffer. Only removes annotations added by add_virtual_text or add_virtual_texts — does not affect highlights, LSP virtual text, inlay hints, or other plugins. Does not modify buffer content. Safe to call even if no annotations are present (returns {cleared: true} either way).

file: path relative to Neovim's cwd (as shown in get_state buffers). The buffer must already be open in Neovim; returns an error otherwise.

Use this to clean up after an annotation workflow. Use add_virtual_text or add_virtual_texts to add annotations.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
fileYes
Behavior5/5

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

No annotations provided; description fully compensates. Discloses what it removes/doesn't remove, that it doesn't modify buffer content, idempotency, return value, and error condition for non-open buffer.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two concise paragraphs: first covers purpose and scope in three sentences, second explains the parameter. Every sentence adds necessary information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given simple tool (one param, no output schema), description covers all aspects: purpose, parameter, return value, error condition, and safe usage. No gaps.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema has 0% description coverage, but description fully explains the 'file' parameter: path relative to cwd, reference to get_state, and requirement that buffer must be open.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Clearly states verb 'Remove' and resource 'MCP virtual text annotations from a Neovim buffer'. Distinguishes from siblings by specifying it only removes annotations added by add_virtual_text or add_virtual_texts, not affecting highlights, LSP, etc.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly says 'Use this to clean up after an annotation workflow' and references sibling tools for adding. States it's safe to call even with no annotations. Could be more specific about when not to use (e.g., use clear_highlights for highlights), but overall clear.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/paulburgess1357/nvim-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server