Skip to main content
Glama
Apple Docs 2.0 MCP

Apple Docs 2.0 MCP

Search Docs Map

search_docs_map
Read-only

Find any Apple documentation page by its title or partial name, covering API symbols, articles, samples, HIG, and endpoints. Returns matching titles, kinds, technologies, and links.

Instructions

Find any page of Apple's documentation by its title, at once: API symbols (types, methods, properties, enum cases, macros), articles, samples, web-service endpoints, Info.plist and entitlement keys, Human Interface Guidelines and App Store Connect Help pages. Use it when you know a name or part of one, from code, an error or another page. Returns each match's title, kind, Beta or Deprecated mark, technology, the page it sits under (which tells same-named members apart) and link, shortest titles first; read one with get_apple_doc_content. It matches titles only, so to search by what something does, use search_apple_docs. Pages Apple added after the map's date, given in each answer, are missing: source "index" reads one framework's sidebar live and matches a wildcard ("*View" structs in SwiftUI, "*Delegate" protocols in UIKit), to see a family of APIs or what's newer than the map, without summaries.

Input Schema

NameRequiredDescriptionDefault
kindNoKeeps one kind of page, as the results name it ("struct", "method", "case", "protocol", "article"); an unknown one is answered with the kinds there are.
limitNoMost results: from the map, the shortest titles first (10 if left out); from an index, in its order (50).
queryYesmap: text the title contains, in any case and as typed, without wildcards: a name ("accessibilityInputLabels(_:)"), part of one ("inputlabels") or a word ("gauge"). index: a wildcard for the whole name, in any case: "*View" ends in View, "UI*" starts with UI, "*feedback*" contains it, "registerForTraitChanges*" finds a method by its name, "*" takes every one.
sourceNo"map": the docs map on disk, every technology at once. "index": one framework's sidebar, read live from Apple's site, for pages newer than the map or a family of names by wildcard; technology names the framework.map
technologyNomap: keeps only the pages these technologies' sidebars list (WebKit's WebView is in SwiftUI's), by the names the results show ("SwiftUI", "Human Interface Guidelines") or IDs ("swiftui"), in any case. index: the one framework, by its name in any case and spacing ("Foundation Models") or its ID ("foundationmodels").

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed8 schema fields changedv0.1.1
    • addedInput schema / properties / kind
      Added value: +{
      +  "description": "Keeps one kind of page, as the results name it (\"struct\", \"method\", \"case\", \"protocol\", \"article\"); an unknown one is answered with the kinds there are.",
      +  "minLength": 1,
      +  "type": "string"
      +}
    • removedInput schema / properties / limit / default
      Removed value: -10
    • changedInput schema / properties / limit / description
      Previous value: -"Max results, shortest titles first (default: 10)."New value: +"Most results: from the map, the shortest titles first (10 if left out); from an index, in its order (50)."
    • changedInput schema / properties / limit / maximum
      Previous value: -100New value: +200
    • changedInput schema / properties / limit / type
      Previous value: -"number"New value: +"integer"
    • changedInput schema / properties / query / description
      Previous value: -"Text the title contains, in any case and taken as typed: a name (\"accessibilityInputLabels(_:)\"), part of one (\"inputlabels\") or a word (\"gauge\")."New value: +"map: text the title contains, in any case and as typed, without wildcards: a name (\"accessibilityInputLabels(_:)\"), part of one (\"inputlabels\") or a word (\"gauge\"). index: a wildcard for the whole name, in any case: \"*View\" ends in View, \"UI*\" starts with UI, \"*feedback*\" contains it, \"registerForTraitChanges*\" finds a method by its name, \"*\" takes every one."
    • addedInput schema / properties / source
      Added value: +{
      +  "default": "map",
      +  "description": "\"map\": the docs map on disk, every technology at once. \"index\": one framework's sidebar, read live from Apple's site, for pages newer than the map or a family of names by wildcard; technology names the framework.",
      +  "enum": [
      +    "map",
      +    "index"
      +  ],
      +  "type": "string"
      +}
    • changedInput schema / properties / technology / description
      Previous value: -"Keep only the pages of these technologies, by the name the results show (\"SwiftUI\", \"UIKit\", \"Human Interface Guidelines\"), in any case."New value: +"map: keeps only the pages these technologies' sidebars list (WebKit's WebView is in SwiftUI's), by the names the results show (\"SwiftUI\", \"Human Interface Guidelines\") or IDs (\"swiftui\"), in any case. index: the one framework, by its name in any case and spacing (\"Foundation Models\") or its ID (\"foundationmodels\")."
  2. First observedv0.1.0

TDQS

A4.6/5.0
Behavior4/5

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

Annotations only declare readOnlyHint=true, so the description is free to add the behavioral detail it does: result fields (title, kind, Beta/Deprecated mark, technology, parent page, link), ordering (shortest titles first), and the important staleness caveat that pages added after the map's date are missing. These are genuinely useful traits beyond the annotation, though it stops short of noting rate limits or index-source auth/availability.

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?

Purpose and the query/source distinction are front-loaded and every clause carries information, but the single dense block packs multiple ideas into run-on sentences, making the index/wildcard behavior harder to parse than it needs to be. Slightly more structure would improve scanability.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the description carries the return-value burden and does so, describing match fields and ordering. It also covers the two source modes, staleness, and the follow-up read tool, so an agent has everything needed to invoke it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the baseline is 3, but the description adds cross-parameter semantics the schema does not: plain substring matching on the map versus whole-name wildcards for the index source, and how technology selection narrows sidebars. This meaningfully helps an agent choose values across the source/query/technology combination.

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 (Find) and resource (any page of Apple's documentation) and enumerates the covered page kinds precisely. It is immediately distinguishable from siblings like search_apple_docs and get_apple_doc_content, which it names.

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 says when to use it ("when you know a name or part of one, from code, an error or another page") and when not to ("It matches titles only, so to search by what something does, use search_apple_docs"). It also routes to get_apple_doc_content for reading a match and explains the index source for wildcard/family browsing, giving the agent clear alternative-selection logic.

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