Skip to main content
Glama

Describe sheet

describe_sheet
Read-onlyIdempotent

Inspect a worksheet's structure: used range, frozen panes, merged ranges, tables, charts, validation, conditional formats, and custom column widths.

Instructions

Describe a sheet's structure: used range, frozen panes, merged ranges, tables, charts, data validation, conditional formats and custom column widths.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesPath to an .xlsx, .xlsm, .xltx or .xltm file. Relative paths are resolved in the server's workbook directory when one is configured; otherwise use an absolute path.
sheetYesWorksheet name, e.g. 'Sheet1'.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYes
tablesYes
used_rangeYes
auto_filterYes
chart_countYes
freeze_panesYes
column_widthsYes
merged_rangesYes
data_validationsYes
conditional_formatsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.1.1

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, openWorldHint=false and destructiveHint=false, so the safety profile is fully covered. The description adds no behavioral detail beyond that, such as whether it fails on missing sheets or how large workbooks are handled, so it clears the lower bar set by annotations but does not exceed it.

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?

A single front-loaded sentence: verb, resource, then a compact comma-delimited list of what is described. No filler, no restatement of the name or title.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With an output schema present, return values need not be explained, and the annotations carry the safety profile, so the description only needs to convey scope. It does that well; the only shortfall is the absence of any usage or failure-mode context for a two-parameter inspector.

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

Parameters3/5

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

Schema coverage is 100%, and the schema itself documents both parameters thoroughly, including supported file extensions and relative-path resolution. The description adds no meaning beyond the schema, which matches the baseline for full coverage.

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 ('Describe') and resource ('a sheet's structure') and enumerates the concrete facets returned: used range, frozen panes, merged ranges, tables, charts, data validation, conditional formats, column widths. The sheet-scoped framing distinguishes it from the sibling describe_workbook without needing to open 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 Guidelines3/5

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

Usage is only implicit: enumerating structural facets signals this is a read-only inspection step, likely before a write/format operation. There is no explicit guidance on when to prefer this over describe_workbook or read_range, and no stated prerequisites.

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