Skip to main content
Glama

Settings Describe

settings_describe
Read-only

Lists every editor property-panel setting and current value for a report, page, or component. Filter by search, include hidden inputs, get the fingerprint for updates; read-only.

Instructions

List every setting of an editor property panel with its current value.

target: {"kind":"report"} (theme, layout, canvas, grid, navigation, report settings), {"kind":"page","page_id":...} (page style, canvas, page data settings) or {"kind":"component","page_id":...,"component_id":...} (every Setup and Style input of any chart/control/text/image/shape, common background/border/header included). Each item: key, label, control, tab, section, value, options (allowed values), min/max, bindings, writable. Search filters by key/label/section. Only inputs the panel currently shows are listed; include_hidden adds the rest (per-series slots, inputs whose UI is conditional). Returns the target fingerprint for settings_set. Read-only.

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": {
      "target": "<target>"
    },
    "name": "settings_describe"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNo
offsetNo
searchNo
targetYesWhat owns the panel: the report, a page, or a component (any depth) on a page.
report_idNo
include_hiddenNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.6.5

TDQS

A3.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and the description confirms "Read-only", so no contradiction. It adds useful behavior beyond annotations: hidden/conditional inputs are excluded by default, and the response carries a fingerprint consumed by settings_set. It does not cover pagination behavior or limits, which matters for a list tool.

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?

Front-loaded with the core action, then structured as a per-target breakdown followed by item fields and modifiers. Dense but nearly every clause carries information; the item-field enumeration is slightly list-like but useful.

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 values need not be spelled out, yet the description still enumerates item fields (key, label, control, tab, section, value, options, min/max, bindings, writable). Combined with the target semantics this is nearly complete, with only pagination semantics missing.

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 only 17%, so the description must compensate. It does explain target kinds, search (filters by key/label/section) and include_hidden well, but limit, offset, and report_id are left entirely to the bare schema, leaving roughly half the parameters without added meaning.

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?

States a specific verb and resource ("List every setting of an editor property panel with its current value") and then enumerates the three target kinds with what each returns, so an agent can distinguish report/page/component scopes without opening the schema. It also names settings_set as the write counterpart, separating it from the sibling.

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?

Gives clear context for each target kind and explains when to use search and include_hidden ("Only inputs the panel currently shows are listed; include_hidden adds the rest"). It implies the read/write split with settings_set but does not state explicit exclusions or when to prefer settings_describe_page.

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