Skip to main content
Glama

get_state

Retrieve a complete read-only snapshot of your Neovim session, including all window details, folds, marks, diagnostics summaries, highlights, and indent settings for thorough analysis.

Instructions

Full snapshot of the current Neovim session. Read-only — does not modify any editor state.

Use get_state_brief for quick orientation at the start of a turn. Use this when you need the complete picture: all window details, folds, marks, diagnostics summaries, highlights, and indent settings.

Returns: mode (normal/insert/visual/etc.), cwd, buffers (relative paths of all listed buffers), modified_buffers, current_tab, tab_count.

windows — list of visible windows (current tab only). The active window is always first, the alternate window (previous) is second. Each window entry contains: file (path relative to cwd), filetype, total_lines, modified, buftype ("file" for normal buffers, "terminal", etc.), line, col, indent: {expandtab, shiftwidth, tabstop}. Optional per-window fields (present when applicable):

  • role: "active" or "alternate".

  • context: numbered lines surrounding the cursor.

  • selection: {start_line, start_col, end_line, end_col} in visual modes.

  • folds: list of [start, end] closed fold ranges.

  • diagnostics_summary: {error, warning, info, hint} counts.

  • marks: list of {mark, line, col} for lowercase (a-z) buffer marks.

  • mcp_highlights: list of {start_line, end_line, color} for active highlights.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior4/5

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

Describes read-only nature, return structure in detail (mode, buffers, windows with optional fields), and ordering (active window first). No annotations present, so description compensates well.

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-organized with clear sections: purpose, usage, then bulleted return structure. Every sentence adds value; no fluff.

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?

No output schema or annotations, so description carries full burden. It completely specifies all fields and optional per-window entries. Sufficient for an agent to understand the tool's output.

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?

Tool has zero parameters; schema coverage is 100%. Baseline for 0 params is 4. Description adds no param info because none 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?

The description states 'Full snapshot of the current Neovim session. Read-only' with a specific verb+resource. It clearly distinguishes from siblings like get_state_brief.

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 tells when to use get_state_brief vs this tool: 'Use `get_state_brief` for quick orientation... Use this when you need the complete picture.'

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