Search Docs Map
search_docs_mapFind 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
| Name | Required | Description | Default |
|---|---|---|---|
| kind | No | 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. | |
| limit | No | Most results: from the map, the shortest titles first (10 if left out); from an index, in its order (50). | |
| query | Yes | 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. | |
| source | No | "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 |
| technology | No | 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"). |