Skip to main content
Glama

Describe workbook

describe_workbook
Read-onlyIdempotent

List a workbook's sheets, used ranges, defined names, and whether it contains macros to understand its structure before reading or editing it.

Instructions

List a workbook's sheets with their used ranges, plus its defined names.

Start here to learn a workbook's structure before reading or editing it. has_vba tells whether the workbook contains macros, which read_vba can show.

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.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYes
sheetsYes
has_vbaYes
size_bytesYes
defined_namesYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.1.1

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already establish readOnly, idempotent, non-destructive behavior, so the safety profile is covered. The description adds useful behavioral context by disclosing what the result contains (sheets, used ranges, defined names) and what the has_vba flag implies, though it does not discuss size limits or performance on large workbooks.

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?

Three short sentences, zero filler, with the output content stated first and the usage guidance front-loaded before the read_vba aside.

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?

For a low-complexity single-parameter read tool with an output schema and full annotation coverage, this is complete: purpose, entry-point guidance, return content, and the macro follow-up are all present.

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?

There is a single 'path' parameter with 100% schema description coverage, so the schema already carries the semantics. The description adds nothing about path handling or formats, and the baseline of 3 for high-coverage schemas applies.

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 a specific verb and resource ('List a workbook's sheets with their used ranges, plus its defined names'), which an agent can distinguish from the sibling describe_sheet that covers a single sheet.

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?

It explicitly says to start here before reading or editing a workbook, giving an ordering heuristic, and it routes macro inspection to read_vba. That is concrete when-to-use and alternative guidance rather than inference.

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