Skip to main content
Glama

Browse Human Interface Guidelines entries

apple_hig_list
Read-onlyIdempotent

Browse and filter Apple HIG entries by category or keyword, returning grouped results to help locate relevant design 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').

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

Input 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. Changed2 schema fields changedv0.2.3
    • removedInput schema / additionalProperties
      Removed value: -false
    • addedInput schema / properties / offset / maximum
      Added value: +9007199254740991
  2. First observedv0.2.1

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, closed-world, so the safety profile needs no restating. The description adds a genuinely non-obvious behavioral trait — that results are grouped by category — which goes beyond both annotations and schema. It omits pagination behavior details (limit default 20, max 100, offset) that would complete the picture.

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?

Three tight sentences with the core action front-loaded and the sibling routing at the end where it belongs. No filler or repetition; the only marginal cost is that the category/section terminology is never reconciled.

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 no-required-parameter, read-only browse tool with strong annotations and no output schema, the definition covers purpose, routing, and output grouping adequately. The remaining gap is that the default page size and page-count mechanics are left entirely to the schema.

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%, with limit and offset undocumented anywhere, so the description should ideally compensate but does not. It mentions category and keyword filtering, but the tool calls the category parameter 'section', creating a naming mismatch an agent must resolve via the schema. The added meaning over the schema is real but partial.

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?

The description opens with a specific verb and resource ("List HIG entries") and immediately states the available filters. It explicitly distinguishes itself from the sibling apple_hig_search by naming it and contrasting browse vs. search semantics.

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?

It gives an explicit routing rule: use apple_hig_search for full-text FTS search, use this tool to browse by category, and supplies concrete category examples ('Foundations', 'Components', 'Inputs'). The when-to-use / when-to-use-the-alternative decision is fully spelled out.

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