Get Apple Doc Content
get_apple_doc_contentFetch any Apple developer documentation page by URL and return its full Markdown content, covering APIs, tutorials, samples, HIG, and App Store Connect help.
Instructions
Read one page of Apple's developer documentation by its URL: an API, article, sample project, tutorial, Human Interface Guidelines page, App Store Connect Help article or web-service endpoint (App Store Connect API, App Store Server API and the like). Returns the whole page as Markdown: summary, declarations, overview with its code, each member with its declaration and summary, relationships, the versions it's available in on each platform with Apple's notes, and See Also; for a sample, its Download link; for a tutorial, its steps with their code; for an endpoint, its URL, parameters and responses. Use it on a search result's link or a URL you already have; language "occ" reads an API's Objective-C version. A view answers one question about an API in less: "related" (what it inherits, conforms to and lists, with summaries), "similar" (what to use instead, led by the pages its deprecation note names), "references" (the pages it links to, with their summaries) or "availability" (the versions that introduced and deprecated it on each platform).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The page's address on developer.apple.com, under /documentation/, /design/human-interface-guidelines/, /tutorials/ or, for view "page" only, /help/app-store-connect/ ("https://developer.apple.com/documentation/swiftui/navigationstack"). Take it from a result or a link: a guessed one often doesn't exist. | |
| view | No | "page": the whole page. The others give one part of an API's page, shorter. "related": what it inherits from and what inherits from it, the protocols it conforms to and the types that conform to it, and its See Also list, each with its one-line summary, plus the first 3 members of each Topics group. "similar": what to use instead or alongside, each with its summary: first the pages its deprecation note names, then its See Also list, then members of its Topics groups; for replacing a deprecated API. "references": the pages it links to, from its lists and inside its text, each with its summary and, for an API, its declaration, grouped by Apple's role for each ("symbol", "article", "collection"). "availability": the title, tagged Deprecated or Beta as Apple's page tags it, and each platform with the version that introduced it and, where deprecated, the version and Apple's note. | page |
| language | No | "swift": the page in Swift; "occ": an API's Objective-C version, its declaration and members as Objective-C writes them. A page Apple writes in Swift alone has none. The views other than "page" read the Swift page. | swift |
| searchDepth | No | similar: "shallow", the pages the deprecation note names and the See Also list, up to 5; "medium", also the first 4 members of each Topics group, up to 10; "deep", also the See Also lists of the first 3 results, up to 15. | medium |
| filterByType | No | references: keeps the linked pages of one role or kind, as Apple names them: "symbol" (APIs), "collection", "article", "sampleCode" and the like. | all |
| maxReferences | No | references: most linked pages to show, not by relevance: those its lists name (Topics, Relationships, See Also) first, then those its text links to. |