Skip to main content
Glama
Apple HIG MCP Server

Apple HIG MCP Server

by Amo643

list_topics

Read-onlyIdempotent

List Apple HIG topics by category, including titles, slugs, and summaries, or retrieve all indexed topics when no category is specified.

Instructions

List all topics within a specific category with their titles, slugs, and summaries.

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_topics"
  }
}

Input Schema

NameRequiredDescriptionDefault
categoryNoOptional category name to filter by (e.g. "Foundations", "Components", "Patterns", "Platforms"). If omitted, lists all indexed topics.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, non-destructive and closed-world, so the safety profile is fully covered. The description adds only the shape of the returned records; it says nothing about ordering, pagination, or result volume for large categories.

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. The minor cost is that its phrasing ("a specific category") slightly obscures the optional, all-topics default behavior.

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?

For a one-optional-parameter list tool with no output schema, the description covers input intent and enumerates returned fields, which is adequate. It stops short of describing ordering, truncation, or what a "summary" contains, which are the remaining unknowns for an agent consuming the output.

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 100% and the schema itself explains that the category filter is optional with example values, so the description adds no parameter meaning beyond that. It actually undersells the parameter by implying a category is required ("within a specific category").

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?

States a specific verb and resource ("List all topics") and enumerates the fields returned (titles, slugs, summaries), so an agent knows exactly what it retrieves. It never names a sibling, so the distinction from list_categories or search_hig must be inferred from the names alone.

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?

Usage is only implied: list topics, optionally scoped to a category. There is no when-to-use/when-not guidance and no routing to alternatives such as search_hig for keyword lookup or list_categories for discovering valid category values.

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