Skip to main content
Glama

List Components

catalog_list
Read-onlyIdempotent

Read components a page at a time. category, trait, context and status filter the list; status describes the HTML renderer. detail is brief by default, or full when filtering; summary includes tags, contexts, regions and traits. Brief and summary allow up to 200 entries; full clamps pageSize to 10 and reports the adjustment. totalCount, hasMore and nextPage describe pagination. object_registry reads objects instead.

Input Schema

NameRequiredDescriptionDefault
pageNo1-based page index for pagination.
traitNoFilter components by trait (e.g., 'Editable', 'Searchable')
detailNoDefaults to brief unfiltered, full with filters. Both defaults are paged (filtered: 10 entries). summary adds tags, contexts, regions and traits; full includes evidence. Explicit detail without paging preserves the unbounded legacy request.
statusNoFilter by legacy static-HTML status only: 'stable' = mapped HTML renderer; 'planned' = HTML fallback. Consult productReality.surfaces for React/Vue, generated-consumer and maturity evidence.
contextNoFilter components by context (e.g., 'detail', 'list')
categoryNoFilter components by category (e.g., 'core', 'lifecycle', 'visual')
pageSizeNoComponents per page. Filtered calls without detail default to 10; nextPage gives the next call.
reproduceNoInclude the command and calls for reproducing this result.
includeInternalNoAlso list OODS Foundry's internal (non-business) objects in registry.objects, after the business objects. Without it they are left out and registry.hiddenInternal counts them.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / detail / description
      Previous value: -"Response detail level. Defaults to brief for unfiltered calls (each component's name, categories and one readiness label) and to full when filters are provided. summary adds tags, contexts, regions, traits and status; the evidence behind the readiness label is only in full."New value: +"Defaults to brief unfiltered, full with filters. Both defaults are paged (filtered: 10 entries). summary adds tags, contexts, regions and traits; full includes evidence. Explicit detail without paging preserves the unbounded legacy request."
    • changedInput schema / properties / pageSize / description
      Previous value: -"Number of components per page."New value: +"Components per page. Filtered calls without detail default to 10; nextPage gives the next call."
  2. Changed2 schema fields changed
    • removedInput schema / $schema
      Removed value: -"https://json-schema.org/draft/2020-12/schema"
    • addedInput schema / properties / reproduce
      Added value: +{
      +  "default": false,
      +  "description": "Include the command and calls for reproducing this result.",
      +  "type": "boolean"
      +}
  3. Changed1 schema field changed
    • changedInput schema / properties / category / description
      Previous value: -"Filter components by category (e.g., 'core', 'data')"New value: +"Filter components by category (e.g., 'core', 'lifecycle', 'visual')"
  4. First observed

TDQS

A4.5/5.0
Behavior5/5

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

Annotations already cover the read-only/idempotent safety profile, yet the description adds real operational context beyond them: pageSize clamping to 10 for full detail with a reported adjustment, the 200-entry ceiling for brief/summary, and the warning that explicit detail without paging 'preserves the unbounded legacy request.' That last caveat is exactly the kind of consequence an agent needs before calling.

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?

Roughly six short sentences, each carrying distinct information, with the core read/pagination behavior front-loaded. The comma-heavy, note-like compression makes a couple of clauses need a second read, but nothing is padding.

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?

For a 9-parameter list tool with no output schema, the description covers the essentials an agent must know: filter semantics, detail-mode defaults and limits, and return fields (totalCount, hasMore, nextPage plus what summary adds). Gaps are minor — includeInternal's registry effect and reproduce are left to the schema.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the baseline is 3. The description still adds value by explaining cross-parameter interactions the schema states only locally: what status actually filters (legacy static-HTML renderer, not React/Vue), how detail and filtering select defaults, and which modes clamp pageSize. It omits reproduce and includeInternal, but the schema carries those adequately.

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?

Names a specific verb and resource ('Read components a page at a time') and immediately distinguishes the tool from the sibling object_registry ('object_registry reads objects instead'). An agent can tell what this returns and how it differs from neighbors without opening any schema.

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?

Explains the conditions that change behavior — filtering selects full detail by default, unfiltered stays brief — and routes object queries to object_registry. It stops short of stating when this tool should not be used (e.g., single-component lookup), but the context and alternative are clear.

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.