Skip to main content
Glama

Get sheet settings

get_sheet_settings
Read-onlyIdempotent

Column headers, value_kind, currency_code, display settings, barcode generator status (enabled, generation_mode), and a catalog block (catalogReady, mappingVersion, roles for every catalog role as strings with empty when unmapped, extras as visible unmapped columns, mappingErrors). Pass sheet_id or sheet_number. value_kind defaults to text. currency_code is an ISO 4217 code or null. Write custom columns by the exact header name returned here.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_sheet_settings"
  }
}

Input Schema

NameRequiredDescriptionDefault
sheet_idNo
sheet_numberNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, closed-world behavior, so the safety profile is covered. The description adds genuinely useful behavioral detail: unmapped catalog roles appear as empty strings, unmapped columns appear under 'extras', and mapping problems surface in 'mappingErrors'. It does not mention permission or error behavior, keeping it below a 5.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The text is dense but poorly structured: it opens with a run-on inventory of returned fields instead of front-loading the tool's purpose, and packs defaults, parameter selection and a write hint into the same paragraph. Little is wasted, but the ordering makes it harder to scan.

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 no output schema, describing the return shape is necessary and the description covers the important pieces (catalog block, role mapping, extras, mappingErrors). For a two-parameter read tool with annotations already carrying the safety profile, this is nearly sufficient; only the input-parameter details are left thin.

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 description coverage is 0%, so the description must carry the load. It does establish that sheet_id or sheet_number are alternatives, which the schema itself does not state, but it omits precedence (what happens if both are supplied), the sheet_number range (1–20), and the identifier format for sheet_id. The value_kind default and ISO 4217 note refer to returned fields rather than input parameters.

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?

The description names a specific verb+resource (get sheet settings) and enumerates exactly what configuration is returned: column headers, value_kind, currency_code, display settings, barcode status, and the catalog block. This clearly separates it from list_sheets and update_sheet_settings, though no sibling is named explicitly.

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?

It gives operational guidance ('Pass sheet_id or sheet_number') and hints at a workflow ('Write custom columns by the exact header name returned here'), but never states when to choose this over list_sheets or update_sheet_settings, nor any prerequisites or exclusions.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources