Skip to main content
Glama
SheetForge MCP

SheetForge MCP

by iHeldan

read_range_formatting

Read-only

Reads a compact formatting summary for a specified worksheet range, so you can inspect styles and layout before editing or analyzing cells.

Instructions

Read a compact formatting summary for a worksheet range.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "filepath": "<filepath>",
      "sheet_name": "<sheet_name>",
      "range_ref": "<range_ref>"
    },
    "name": "read_range_formatting"
  }
}

Input Schema

NameRequiredDescriptionDefault
filepathYesReuse supplied server path; NEVER prepend client cwd. Rooted: relative OK; unrooted stdio: absolute, ask if missing.
range_refYes
sheet_nameYes
sample_limitNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.14.0
    • addedInput schema / properties / filepath / description
      Added value: +"Reuse supplied server path; NEVER prepend client cwd. Rooted: relative OK; unrooted stdio: absolute, ask if missing."
  2. First observedv0.8.0

TDQS

C2.9/5.0
Behavior3/5

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

readOnlyHint=true already tells the agent this is a safe non-mutating read, so the description's burden is lighter. It adds that the result is 'compact' — a summary rather than a full formatting dump — which is genuinely useful context, but it never says what is summarized (number formats, fills, borders?) or how the compacting works.

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?

One front-loaded sentence with zero filler — nothing to trim. Its weakness is under-specification rather than verbosity, but as pure structure it is efficient.

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

Completeness2/5

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

No output schema exists, so the description must explain what a 'formatting summary' returns and how sample_limit affects it; it does neither. For a 4-parameter tool with 25% schema coverage, an agent is left guessing about the response shape and two of the inputs.

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 only 25%: sheet_name and range_ref are bare strings and sample_limit has a default of 10 with no explanation. The description's 'compact ... summary' hints at why a sample limit exists, but it never mentions sampling, sample size, or the accepted range_ref syntax, so it fails to compensate for the coverage 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 and resource ('Read a compact formatting summary for a worksheet range'), which clearly separates it from data-reading siblings like read_data_from_excel or query_table. It does not, however, name or contrast itself against the adjacent formatting/inspection tools (format_range, inspect_conditional_format_rules, describe_sheet_layout).

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

Usage Guidelines2/5

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

There is no statement of when to reach for this tool versus alternatives such as read_data_from_excel (values) or describe_sheet_layout (structure). The word 'formatting' only implies the use case; nothing tells the agent what problem this solves or when not to call it.

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

Deploy Server

Other Tools