Skip to main content
Glama

get_state_brief

Retrieve a quick snapshot of the current Neovim session including mode, working directory, buffers, and cursor context. Use at the start of each interaction to orient yourself.

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?

States 'Read-only — does not modify any editor state' upfront. Describes return fields in detail, including conditional alternate_window. No annotations provided, so description fully bears burden and does so excellently.

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?

Concise yet comprehensive: each sentence adds value. Front-loaded with purpose and read-only note, followed by usage and return details. No filler.

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?

With no output schema, description fully explains return values, including field composition, context format, and alternate_window condition. Sufficient for agent to understand what to expect.

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?

Input schema has zero parameters; per guidelines baseline is 4. Description adds no parameter info as none exist. No deduction needed.

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 it provides a 'lightweight snapshot' for 'quick orientation', listing specific returned fields (mode, cwd, buffers, etc.). Distinguishes from sibling tool get_state by contrasting 'lightweight' vs 'full picture'.

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?

Explicitly advises use at the start of each turn and directs to get_state when a more comprehensive view is needed. Provides clear when-to-use and when-not-to-use with named 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