Skip to main content
Glama

get_state

Retrieve a complete read-only snapshot of the current Neovim session, including windows, buffers, modes, marks, and diagnostics. Get full details without modifying editor state.

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, virtual text, and indent settings.

Returns: mode (normal/insert/visual/etc.), cwd, buffers (relative paths of all listed buffers), modified_buffers, current_tab, tab_count, and terminals — a list of open terminal buffers as {buf, name, visible}, present only when at least one exists (targets for send_to_terminal).

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.

  • mcp_virtual_text: list of {line, position, lines, color} for active virtual text.

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 of behavioral disclosure. It opens with 'Read-only — does not modify any editor state,' which is a clear and explicit safety declaration. It then details the return structure comprehensively, including optional fields and their conditions, providing transparency about what the agent can expect without any side effects.

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 long but well-structured, front-loaded with purpose and usage, then organized by logical sections (windows, per-window fields, optional fields). Each sentence provides necessary detail about what the tool returns, and the formatting with headings and bullet-like lists enhances scannability without redundancy.

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?

Since there is no output schema, the description must fully explain the return values. It does so exhaustively, covering top-level fields, per-window subfields, and optional fields with their shapes. It also explains relationships (e.g., active window first, alternate second) and conditions (e.g., terminals only present when at least one exists), making the tool completely self-contained for an AI agent.

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?

This tool has zero parameters, so there are no parameter semantics to explain. The baseline for 0 parameters is 4. The description does not discuss inputs because none exist; it focuses on output, which is appropriate for a parameterless getter.

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 begins with 'Full snapshot of the current Neovim session,' using a specific verb ('snapshot') and resource ('Neovim session'). It clearly distinguishes this from the sibling 'get_state_brief' by stating that this tool provides the complete picture, including all window details, folds, marks, diagnostics, etc.

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 provides explicit usage guidance: 'Use get_state_brief for quick orientation at the start of a turn. Use this when you need the complete picture.' This directly contrasts with an alternative, making the selection criteria clear. It also notes that the terminals field is a target for send_to_terminal, giving additional context for when this tool may be useful.

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