Skip to main content
Glama

get_state_brief

Retrieve a lightweight snapshot of the Neovim session including mode, cwd, buffers, modified buffers, and active window context for quick orientation at the start of each turn.

Instructions

Lightweight snapshot of the Neovim session for quick orientation. Read-only — does not modify any editor state.

Use this at the start of each turn to see what the user is working on. Use get_state instead when you need the full picture: all windows, folds, marks, diagnostics summaries, highlights, and indent settings.

Returns: mode (normal/insert/visual/etc.), cwd, buffers (relative paths of all listed buffers), modified_buffers, and active_window: {file, filetype, total_lines, modified, buftype, line, col, context}. context is a short list of numbered lines around the cursor.

If an alternate window exists, also returns alternate_window with the same fields.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior5/5

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

With no annotations provided, the description carries the full burden, and it fully discloses the read-only nature, the return fields (mode, cwd, buffers, etc.), the conditional alternate_window, and the format of context. No hidden behaviors are implied.

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?

The description is extremely concise, with every sentence serving a clear purpose: purpose, safety note, usage guidance, and return details. It is front-loaded with the most critical 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 the tool has no parameters and no output schema, the description is self-sufficient. It explains all return fields and how they are structured. The context of sibling tools (like `get_state`) is properly referenced for completeness.

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

Parameters4/5

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

The input schema has zero parameters and 100% schema description coverage, so the description does not need to add parameter info. However, it compensates by thoroughly explaining the return structure, which is valuable for understanding the tool's output even though no output schema exists.

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 the tool is a 'lightweight snapshot of the Neovim session for quick orientation' and explicitly distinguishes it from the sibling tool `get_state`, which provides the 'full picture'. The verb 'get' and resource 'state brief' are specific and well-defined.

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

Usage Guidelines5/5

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

The description gives explicit guidance: 'Use this at the start of each turn to see what the user is working on. Use `get_state` instead when you need the full picture.' This clearly advises when to use this tool versus an alternative.

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