Skip to main content
Glama
KitchenSink4AI

io.github.nometalalchemist/kitchensink4xl

Get Workbook Metadata

get_workbook_metadata
Read-only

Avoid edit risks by reading a workbook's structure read-only: sheets, visibility, true used ranges, merged cells, names, tables, active sheet, and a round-trip hazard summary.

Instructions

Read a workbook's structure without opening it for edit: every sheet with its visibility state, TRUE used range (value-bearing bounds, not the often wrong stored dimension), dimensions, and merged-cell count, plus defined names, tables, the active sheet, and a round-trip hazard summary (whether an openpyxl edit would drop fragile parts). The orient-before-editing call. Read-only; works while the file is open in Excel.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.2.0
    • changedOutput schema / (root)
      Previous value: -{
      -  "additionalProperties": true,
      -  "type": "object"
      -}New value: +null
  2. First observedv1.0.0

TDQS

A4.3/5.0
Behavior5/5

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

Annotations already establish read-only behavior, and the description adds meaningful detail beyond that: it does not open the file for edit, works while Excel has the file open, reports the TRUE used range rather than possibly stale stored dimensions, and includes an openpyxl round-trip hazard summary. No contradiction with readOnlyHint or openWorldHint.

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 dense but well-structured: the first sentence front-loads the action and lists the returned metadata, while the two short fragments add usage and behavioral context. Every clause earns its place; the parenthetical about TRUE used range is lengthy but informative.

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?

Even without an output schema, the description enumerates the principal return fields, making the result set predictable. It also covers read-only behavior, concurrent use with Excel, and the hazard-summary caveat. Nothing critical is missing for this simple one-parameter tool.

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?

The single 'path' parameter is reasonably self-evident from its name plus the tool description's 'workbook' context, so an agent can infer it refers to the workbook file. However, with 0% schema description coverage, the description itself adds no explicit path format, supported extension, or location guidance, so it only partially compensates for the schema gap.

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?

States a specific verb ('Read') and resource ('a workbook's structure'), then enumerates exactly what is returned: sheets, visibility, TRUE used range, dimensions, merged-cell count, defined names, tables, active sheet, and a round-trip hazard summary. It is clearly a read-only metadata/introspection tool, though it does not explicitly contrast with the sibling diagnose_workbook, so sibling differentiation is implicit rather than stated.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

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

Provides clear usage context with 'The orient-before-editing call' and 'Read-only; works while the file is open in Excel', signaling that this is the pre-edit inspection step. It does not name alternative tools or state explicit when-not-to-use conditions, but the intended context is unambiguous.

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