Skip to main content
Glama

Search Human Interface Guidelines

apple_hig_search
Read-onlyIdempotent

Search Apple Human Interface Guidelines by keyword to locate HIG topics covering components, patterns, and platforms; returns Markdown or JSON with adjustable result limits.

Instructions

Keyword search across HIG topics (components, patterns, platforms).

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": {
      "query": "<query>"
    },
    "name": "apple_hig_search"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNo
queryYesSearch query; supports multi-word phrases.
formatNoResponse formatmarkdown

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv0.2.3
    • removedInput schema / additionalProperties
      Removed value: -false
    • addedInput schema / properties / query / description
      Added value: +"Search query; supports multi-word phrases."
    • addedInput schema / properties / query / maxLength
      Added value: +500
  2. First observedv0.2.1

TDQS

C2.9/5.0
Behavior2/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false, and openWorldHint=false, so the safety profile is fully covered by structured data. The description adds topical scope but nothing behavioral: no mention of ranking/relevance behavior, how many results come back by default, or the effect of the limit parameter. For a search tool where result-shaping behavior is the main unknown, this leaves the agent guessing.

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?

A single front-loaded sentence with no filler, and the corpus scope appears immediately. Its brevity is close to under-specification rather than model conciseness, but nothing in it is wasted.

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?

This is a simple three-parameter read-only search, and annotations plus the schema cover most of what an agent needs. However, there is no output schema, so the description could have stated what a result looks like (topic title, path, snippet) and how relevance ordering works. As written it is minimally sufficient rather than complete.

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 67%: query documents multi-word phrase support and format documents the response type, while limit is documented only via type/bounds/default. The description itself adds no parameter meaning beyond the schema, not even a note that format controls markdown vs json output. With the schema carrying most of the load, a baseline 3 is appropriate.

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 names a specific verb and resource ("Keyword search across HIG topics") and scopes the corpus with a parenthetical (components, patterns, platforms). That is enough for an agent to know this searches Apple's Human Interface Guidelines rather than docs or WWDC content. It does not distinguish itself from close siblings such as apple_hig_list (topic listing) or apple_search_all (cross-corpus search), which keeps it from a 5.

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

Usage Guidelines2/5

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

There is no when-to-use or when-not-to-use guidance, and no named alternative despite a crowded sibling set that includes apple_hig_list, apple_search_all, appstore_guidelines_search, and apple_doc_lookup. The agent must infer that keyword search is appropriate when it has a term rather than a known topic identifier. This is implied usage at best.

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