Skip to main content
Glama

get_state_brief

Retrieve a lightweight, read-only snapshot of the current Neovim session to see mode, working directory, open/modified buffers, active window, and cursor context before reading or editing files.

Instructions

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

Use this when a turn depends on what the user is working on: before reading or editing files, acting on the editor, or answering about the current view. One call per turn is enough; skip it for turns that don't touch the editor or files. Use get_state instead when you need the full picture: all windows, 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, 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. When terminal buffers exist, returns terminals — a list of {buf, name, visible} (targets for send_to_terminal).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.6/5.0
Behavior4/5

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

No annotations are provided, so the description carries the full burden, and it does disclose the key trait: 'Read-only — does not modify any editor state.' It also enumerates the return contents in detail. It stops short of describing edge cases like large-file behavior or cost, but the safety profile and output shape are clear.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Well front-loaded: purpose first, then usage routing, then the return shape. The Returns paragraph is long but justified since there is no output schema. It is a touch verbose in enumerating every field, but every line is informative rather than 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, the description fully specifies what is returned (mode, cwd, buffers, modified_buffers, active_window and its fields, context, alternate_window, terminals) and even links terminals to the send_to_terminal sibling. Nothing an agent needs to call it correctly is missing.

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 tool takes zero parameters, so there is nothing for the schema to document and no parameter semantics to clarify. Baseline of 4 is appropriate for a no-arg tool.

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?

States a specific verb and resource: a 'lightweight snapshot of the Neovim session for quick orientation.' It also differentiates itself from the sibling get_state by naming it as the fuller alternative, so an agent can distinguish the two without opening either schema.

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?

Gives explicit when-to-use ('when a turn depends on what the user is working on: before reading or editing files...'), when-not ('skip it for turns that don't touch the editor or files'), and the alternative ('Use get_state instead when you need the full picture'). It even specifies a frequency constraint ('one call per turn is enough').

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.