Skip to main content
Glama

List the UI pattern catalog

list_ui_patterns
Read-onlyIdempotent

Lists the 98 UI patterns in CatchUI's curated catalog — ids, English and Chinese names and one-line definitions — grouped by family, optionally filtered to one family (NAV, INPUT, ACTION, OVERLAY, FEEDBACK, CONTENT, DATA, SYSTEM).

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": "list_ui_patterns"
  }
}

Input Schema

NameRequiredDescriptionDefault
familyNoOnly list patterns in this family.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

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

The annotations already cover the safety profile (readOnly, idempotent, non-destructive, closed-world), so the description's job is to add context. It does so by disclosing the full catalog size (98), the grouping behavior by family, and the exact payload fields, which tells an agent this is a complete bulk read rather than a paginated or partial one.

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

Conciseness5/5

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

It is a single front-loaded sentence that states the verb, the count, the returned fields, the grouping, and the optional filter, with no redundant wording. The em-dash clause keeps the payload description compact and easy 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?

For a one-optional-parameter read-only listing with no output schema, the description usefully specifies what each entry contains and how results are grouped. It leaves minor gaps such as ordering within a family and whether all 98 entries always return, but nothing an agent needs in order to call it correctly is 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 100%, and the enum already lists all eight family codes with a description, so the schema carries the parameter semantics. The description restates the optional single-family filter and repeats the enum values without adding format or behavior detail, which matches the baseline 3.

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 uses a specific verb (Lists) and resource (the 98 UI patterns in CatchUI's curated catalog) and spells out exactly what fields come back (ids, English/Chinese names, one-line definitions). It does not name a sibling, so an agent must infer on its own that search_ui_patterns is the keyword-driven alternative.

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?

The phrase 'optionally filtered to one family' implies when to pass the parameter, but the description never states when to use this tool instead of search_ui_patterns or get_ui_pattern. There are no exclusions and no prerequisites; the usage boundary is only implied.

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