Skip to main content
Glama

highlight_range

Add a colored line highlight to a Neovim buffer for visual annotation without modifying content. Specify file, start and end lines, and a hex color or highlight group.

Instructions

Add a colored line highlight to a Neovim buffer. This is a visual annotation only — it does not modify buffer content and is not persisted to disk. Highlights stack; calling this multiple times adds more highlights without removing previous ones.

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. start_line: first line to highlight (1-indexed, inclusive). end_line: last line to highlight (1-indexed, inclusive). Out-of-range values are clamped. If start_line > end_line they are swapped. color: a hex color (e.g. "#3b4048") or a Neovim highlight group name (e.g. "Comment", "DiagnosticError"). For groups, the resolved foreground color becomes the line background — so highlights adapt to the user's colorscheme. Defaults to "Comment". Unknown names (including bare color literals like "Red") return an error.

Use this for a single highlight. Use highlight_ranges to apply multiple highlights in one call. Use clear_highlights to remove all highlights from a buffer.

Returns {highlighted} with the number of lines highlighted, or {error} with a message on failure.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
fileYes
start_lineYes
end_lineYes
colorNoComment
Behavior4/5

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

No annotations provided, so description must disclose behavior. It explains highlights stack, no persistence, line clamping/swapping, color handling. Lacks mentions of permissions or side effects, but for a non-destructive tool, this is sufficient.

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?

Well-structured: purpose first, then parameter details, usage alternatives, return value. Every sentence adds value with no redundancy.

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

Completeness4/5

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

Given 4 parameters (3 required) and no output schema, description explains return value (highlighted count or error). Sufficient for a highlight tool, though missing limits or performance notes.

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 coverage is 0% (only titles and types given). Description adds path context, indexing, clamping behavior, color defaults and error conditions, significantly enriching parameter understanding.

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?

The description clearly states 'Add a colored line highlight to a Neovim buffer' and distinguishes it as a visual-only annotation. It differentiates from siblings by mentioning highlight_ranges and clear_highlights.

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?

It specifies when to use highlight_ranges (multiple highlights) and clear_highlights (removal). It notes the buffer must be open. No explicit when-not-to-use, but context is 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