Skip to main content
Glama

Browse Human Interface Guidelines entries

apple_hig_list
Read-onlyIdempotent

List Apple Human Interface Guidelines entries filtered by category or keyword, grouped by section, to browse design topics and find relevant guidance.

Instructions

List HIG entries with optional category and keyword filters. Groups results by category. Use apple_hig_search for full-text FTS search; use this to browse by category (e.g. 'Foundations', 'Components', 'Inputs').

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNo
formatNoResponse formatmarkdown
offsetNo
keywordNoKeyword filter applied to title and body.
sectionNoHIG category substring filter, e.g. 'Foundations', 'Components', 'Inputs'.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.1

TDQS

A4.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is covered. The description adds a real behavioral trait ('groups results by category'), but says nothing about pagination despite limit/offset params, nor return format. Adds some value but not rich context.

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?

Two tightly written sentences, front-loading what the tool does before the alternative routing. Nothing is redundant and no sentence is wasted.

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?

No output schema exists, and the description supplies the key return-shape fact (grouped by category) plus filter routing. Minor gaps remain around pagination and the format parameter, but an agent has enough to call it correctly.

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 coverage is 60%, and the schema already carries descriptions for keyword, section, and format. The description restates the category/keyword filters and adds example values, but leaves limit/offset/format unexplained, which is baseline-adequate rather than additive.

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 ('List'), resource ('HIG entries'), and scope (optional category/keyword filters, grouped by category). It also names the sibling it is not ('apple_hig_search'), so an agent can distinguish browse-vs-search without opening a schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly routes between this tool and the alternative: 'Use apple_hig_search for full-text FTS search; use this to browse by category.' It gives the selecting condition and concrete category examples ('Foundations', 'Components', 'Inputs').

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