Skip to main content
Glama

Describe workbook

describe_workbook
Read-onlyIdempotent

Inspect an Excel workbook to list its sheets, used ranges, object counts, defined names, properties, and calculation settings. Use it to understand workbook structure before editing.

Instructions

Start here: a workbook's sheets (used range, object counts), defined names, properties and calculation settings. has_vba appears only when true (read_vba).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
sheetsYes
has_vbaNo
calculationNo
chart_sheetsNo
defined_namesNo
doc_propertiesNo
structure_protectedNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed30 schema fields changedv2.0.0
    • removedInput schema / properties / path / description
      Removed value: -"Path 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."
    • removedInput schema / properties / path / title
      Removed value: -"Path"
    • removedInput schema / title
      Removed value: -"describe_workbookArguments"
    • addedOutput schema / $defs / CalculationInfo
      Added value: +{
      +  "properties": {
      +    "full_calc_on_load": {
      +      "type": "boolean"
      +    },
      +    "iterative": {
      +      "type": "boolean"
      +    },
      +    "max_change": {
      +      "default": 0.001,
      +      "type": "number"
      +    },
      +    "max_iterations": {
      +      "default": 100,
      +      "type": "integer"
      +    },
      +    "mode": {
      +      "default": "auto",
      +      "enum": [
      +        "auto",
      +        "manual",
      +        "auto_except_tables"
      +      ],
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
    • addedOutput schema / $defs / DefinedNameInfo
      Added value: +{
      +  "properties": {
      +    "name": {
      +      "type": "string"
      +    },
      +    "refers_to": {
      +      "type": "string"
      +    },
      +    "sheet": {
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "name",
      +    "refers_to"
      +  ],
      +  "type": "object"
      +}
    • addedOutput schema / $defs / ObjectCounts
      Added value: +{
      +  "properties": {
      +    "charts": {
      +      "default": 0,
      +      "type": "integer"
      +    },
      +    "images": {
      +      "default": 0,
      +      "type": "integer"
      +    },
      +    "pivot_tables": {
      +      "default": 0,
      +      "type": "integer"
      +    },
      +    "slicers": {
      +      "default": 0,
      +      "type": "integer"
      +    },
      +    "tables": {
      +      "default": 0,
      +      "type": "integer"
      +    }
      +  },
      +  "type": "object"
      +}
    • addedOutput schema / $defs / PropertiesInfo
      Added value: +{
      +  "properties": {
      +    "author": {
      +      "default": "",
      +      "type": "string"
      +    },
      +    "company": {
      +      "default": "",
      +      "type": "string"
      +    },
      +    "keywords": {
      +      "default": "",
      +      "type": "string"
      +    },
      +    "subject": {
      +      "default": "",
      +      "type": "string"
      +    },
      +    "title": {
      +      "default": "",
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
    • addedOutput schema / $defs / SheetSummary / properties / active
      Added value: +{
      +  "type": "boolean"
      +}
    • removedOutput schema / $defs / SheetSummary / properties / columns
      Removed value: -{
      -  "title": "Columns",
      -  "type": "integer"
      -}
    • removedOutput schema / $defs / SheetSummary / properties / name / title
      Removed value: -"Name"
    • addedOutput schema / $defs / SheetSummary / properties / objects
      Added value: +{
      +  "$ref": "#/$defs/ObjectCounts",
      +  "default": {
      +    "charts": 0,
      +    "images": 0,
      +    "pivot_tables": 0,
      +    "slicers": 0,
      +    "tables": 0
      +  }
      +}
    • removedOutput schema / $defs / SheetSummary / properties / rows
      Removed value: -{
      -  "title": "Rows",
      -  "type": "integer"
      -}
    • removedOutput schema / $defs / SheetSummary / properties / used_range / title
      Removed value: -"Used Range"
    • addedOutput schema / $defs / SheetSummary / properties / visibility
      Added value: +{
      +  "default": "visible",
      +  "enum": [
      +    "visible",
      +    "hidden",
      +    "very_hidden"
      +  ],
      +  "type": "string"
      +}
    • removedOutput schema / $defs / SheetSummary / properties / visible
      Removed value: -{
      -  "title": "Visible",
      -  "type": "boolean"
      -}
    • changedOutput schema / $defs / SheetSummary / required
      Previous value: -[
      -  "name",
      -  "used_range",
      -  "rows",
      -  "columns",
      -  "visible"
      -]New value: +[
      +  "name",
      +  "used_range"
      +]
    • removedOutput schema / $defs / SheetSummary / title
      Removed value: -"SheetSummary"
    • addedOutput schema / properties / calculation
      Added value: +{
      +  "$ref": "#/$defs/CalculationInfo",
      +  "default": {
      +    "full_calc_on_load": false,
      +    "iterative": false,
      +    "max_change": 0.001,
      +    "max_iterations": 100,
      +    "mode": "auto"
      +  }
      +}
    • addedOutput schema / properties / chart_sheets
      Added value: +{
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / properties / defined_names / items / $ref
      Added value: +"#/$defs/DefinedNameInfo"
    • removedOutput schema / properties / defined_names / items / type
      Removed value: -"string"
    • removedOutput schema / properties / defined_names / title
      Removed value: -"Defined Names"
    • addedOutput schema / properties / doc_properties
      Added value: +{
      +  "$ref": "#/$defs/PropertiesInfo",
      +  "default": {
      +    "author": "",
      +    "company": "",
      +    "keywords": "",
      +    "subject": "",
      +    "title": ""
      +  }
      +}
    • removedOutput schema / properties / has_vba / title
      Removed value: -"Has Vba"
    • removedOutput schema / properties / path
      Removed value: -{
      -  "title": "Path",
      -  "type": "string"
      -}
    • removedOutput schema / properties / sheets / title
      Removed value: -"Sheets"
    • removedOutput schema / properties / size_bytes
      Removed value: -{
      -  "title": "Size Bytes",
      -  "type": "integer"
      -}
    • addedOutput schema / properties / structure_protected
      Added value: +{
      +  "type": "boolean"
      +}
    • changedOutput schema / required
      Previous value: -[
      -  "path",
      -  "size_bytes",
      -  "has_vba",
      -  "sheets",
      -  "defined_names"
      -]New value: +[
      +  "sheets"
      +]
    • removedOutput schema / title
      Removed value: -"WorkbookInfo"
  2. Addedv1.1.1

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, so safety is covered. The description adds a genuinely useful behavioral detail beyond the annotations: has_vba is conditionally present only when true, and read_vba is the way to expand on it. That is real context about output shape that the agent could not get from the annotations.

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?

Two compact sentences with the orienting cue "Start here" front-loaded, followed by the payload list and the conditional field note. No filler or repetition.

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?

An output schema exists, so return-value explanation is unnecessary, and the description still summarizes the returned categories well. The only real gap is the undocumented path argument, which leaves the call slightly under-specified for a single-required-param tool.

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

Parameters2/5

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

Schema description coverage is 0% and the single path parameter is undocumented in the schema, so the description must compensate - but it says nothing about what path refers to, whether it is absolute or relative, or what formats are accepted. The agent is left to guess that it is a workbook file path.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

Names the resource (workbook) and enumerates precisely what it returns: sheets with used range and object counts, defined names, properties, and calculation settings. This clearly separates it from the sibling describe_sheet, which operates at sheet scope, though the description never explicitly contrasts the two.

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?

"Start here" implies this is the entry-point call for inspecting a workbook, and the read_vba pointer gives one concrete follow-up path. However, there is no explicit when-not guidance or statement of prerequisites, leaving the agent to infer the workflow position.

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