Skip to main content
Glama

Settings Describe Page

settings_describe_page
Read-only

Describe settings for every component on a page in one read-only call, with an optional search filter to keep results small. Returns each component's type and items plus the page fingerprint for batch writes.

Instructions

settings_describe for every component of a page (or the listed ones) in ONE call: {component_id: {type, items}} plus the page fingerprint for settings_set_batch. Use search to keep it small (e.g. "boxShadow"). Far faster than one settings_describe per component. 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": {
      "page_id": "<page_id>"
    },
    "name": "settings_describe_page"
  }
}

Input Schema

NameRequiredDescriptionDefault
searchNo
page_idYes
report_idNo
component_idsNo
include_hiddenNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.6.5

TDQS

A3.6/5.0
Behavior3/5

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

The annotations already declare readOnlyHint=true, and the trailing 'Read-only' merely restates that, earning no credit. Beyond annotations it does add useful behavior: the response shape, the included page fingerprint and its consumer (settings_set_batch), and the practical warning that results can be large so search should be used to constrain them. It says nothing about result-size limits, pagination, or what include_hidden actually changes, which leaves gaps for a tool whose output can be large.

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?

It is compact and front-loaded, leading with the operation and its return shape before the speed comparison and the search tip. The parentheticals and the embedded response-shape notation make it dense but every sentence carries information. No filler sentences and no repetition of schema fields.

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

Completeness3/5

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

An output schema exists, so the description does not need to explain return values in depth, and it sensibly only summarizes the shape and fingerprint. Still, for a five-parameter batch read it omits the meanings of report_id and include_hidden and gives no guidance on failure or permission conditions. It is adequate but leaves real gaps an agent would have to guess at.

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 parameter meaning and it only partly does. It clarifies search with a concrete example ('boxShadow') and its purpose of shrinking results, and explains component_ids as 'the listed ones'; page_id is implied by the operation. However, report_id and include_hidden are never mentioned anywhere, leaving two of five parameters completely opaque.

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 states a concrete operation and resource: batch-describe settings for every component on a page (or a listed subset), returning {component_id: {type, items}} plus the page fingerprint. It explicitly distinguishes itself from the sibling settings_describe by noting it is 'far faster than one settings_describe per component,' so an agent can pick the right one. The only weakness is that it borrows meaning from another tool's name ('settings_describe for every component') rather than describing the operation standalone.

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?

It gives concrete selection context: use it instead of looping settings_describe per component, and it names the workflow target by saying the fingerprint feeds settings_set_batch. It also advises narrowing with search to keep the result small. It stops short of explicit exclusions (for example, when a single component's full settings via settings_describe would be preferable).

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