apple-docs MCP server
Commit Nov 15, 2026Provides an offline-first local corpus of Apple developer documentation for AI assistants to search and read via MCP.
Also known as g-cqd/apple-docs
- Stars
- 27
- Tools
- —
- Downloads, 30 days
- —
- Latest version
- —
- Last commit
- Nov 15, 2026
- License
- MIT
What is apple-docs MCP?
apple-docs provides an offline-first local corpus of Apple developer documentation for AI assistants to search and read via MCP.
Summary generated from the project's README
About apple-docs MCP server
Developers building for Apple platforms can access a massive, offline-first collection of documentation directly through their AI assistants. This server provides an indexed corpus of approximately 393,000 documents, including API references, Human Interface Guidelines, App Store Review Guidelines, and WWDC session transcripts spanning from 1997 to 2026. By running this locally, you ensure your AI client uses verified technical facts instead of making guesses about Swift or SwiftUI syntax.
Setup requires Bun 1.1+ and involves downloading a verified archive that ranges from 4.6 GB to 10.5 GB depending on your chosen storage profile. Once installed, you can connect it to clients like Claude, Cursor, or Codex using the provided MCP configuration. The server operates via stdio or a streamable HTTP server and includes nine specialized tools such as search_docs, read_doc, and search_sf_symbols. Because the semantic index is built locally, no cloud APIs or external keys are required for searching.
What you can do with it
- 1Verify SwiftUI syntax with real documentationAsk your AI assistant to find the specific implementation details for a SwiftUI view to ensure code accuracy.
- 2Search WWDC session transcripts offlineQuery specific technical topics from past developer conferences to find implementation guidance.
- 3Consult Human Interface GuidelinesHave an AI agent check your app design against official Apple interface standards.
Written from the project's README. Every use case is checked against a quote from it.
Automated checks
Ran Nov 14, 2026Full report →Not verified yet. A server needs a score of 80, no serious finding, and enough data for us to check. How checks work · What to fix for more points
- Source repository linked and reachableg-cqd/apple-docs is public and reachablegithub.com/g-cqd/apple-docs ↗Pass
- Package names this repository as its sourceNot checked
- Build provenance (Sigstore attestation)Not checked
- Open source license (OSI)MITspdx.org/licenses/MIT.html ↗Pass
- Commit or release in the last yearLast commit or release 2026-11-09github.com/g-cqd/apple-docs ↗Pass
- OpenSSF ScorecardOpenSSF Scorecard 7.6 / 10; weakest: Code-Review 0, CII-Best-Practices 0, Signed-Releases 0scorecard.dev/viewer/?uri=github.com/g-cqd/apple-docs ↗Pass
- Package name not close to a popular packageNot checked
- No critical advisory in the package or its dependenciesNot checked
- No hidden instructions to the model0 tool descriptions and the README read; no override phrases, credential paths or hidden charactersPass
- Destructive tools are labelledNot checked
- Remote endpoint answers the MCP handshakeNot checked
README
View on GitHubapple-docs
All of Apple's developer documentation, on your machine. Search it from the terminal, browse it in your browser, and plug it into Claude, Codex, Cursor, or any other MCP client — fully offline once installed.
One indexed corpus (~393,000 documents), three ways in:
- CLI —
apple-docs search "NavigationStack"answers in milliseconds. - MCP server — your AI assistant cites real Apple docs instead of guessing.
- Local website — browse and full-text search in the browser, or publish it as a static site.
It covers Apple's API reference (DocC), Human Interface Guidelines, App Store Review Guidelines, Swift Evolution, the Swift book, Swift.org, WWDC sessions (1997–2026, transcripts included), Apple sample code, archived documentation, a Swift package catalog, every SF Symbol, and Apple's fonts.
Quick start
You need Bun 1.1+.
git clone https://github.com/g-cqd/apple-docs.git
cd apple-docs
bun run dev:setup # install dependencies + link the CLI
apple-docs setup # download + install the latest snapshot
setup downloads one verified archive (1.16 GB) and installs it in a few
minutes. After that, everything works offline:
apple-docs search "NavigationStack"
apple-docs search "how do I record audio in the background"
apple-docs read swiftui/view
Search takes both forms: exact symbol names and plain-English questions (a local semantic index is built during setup — no cloud, no API key).
Pick a disk/speed tradeoff (optional)
setup asks which storage profile you want; flags skip the prompt:
| Command | Disk | Best for | |
|---|---|---|---|
| Smallest | apple-docs setup --compact |
~4.6 GB | laptops, CI |
| Default | apple-docs setup |
~7.1 GB | most setups |
| Fastest reads | apple-docs setup --prebuilt |
~10.5 GB | serving the website |
All three contain the full corpus and search identically — they only trade
disk for read speed. Details and how to switch later:
docs/configuration.md.
Those disk figures come from the last full profile verification (
snapshot-20260611, ~353k documents). The corpus has grown since — abalancedinstall ofsnapshot-20260805-beta.2measures ~11 GB — so treat them as a floor and re-measure withbun scripts/verify-profiles.mjsif the exact number matters.
Prefer a standalone binary or a production self-host? See
docs/installing.md.
Everyday commands
# Search — filters beat clever queries
apple-docs search "Swift Testing" --source wwdc --year 2024
apple-docs search "privacy" --framework app-store-review
apple-docs search "scroll" --kind article --platform visionos
# Read a page (or just one section of it)
apple-docs read swiftui/view
apple-docs read View --framework swiftui
apple-docs read swiftui/view --section Overview
# Explore
apple-docs frameworks # every documentation root
apple-docs browse swiftui # a framework's pages
apple-docs browse wwdc # WWDC years with session counts
apple-docs browse wwdc --year 2025 # one year's sessions
apple-docs status # corpus freshness + counts
apple-docs --help and apple-docs <command> --help are the exhaustive
reference.
Use it from your AI tools (MCP)
apple-docs mcp install # prints ready-to-paste client config
apple-docs mcp start # stdio server
apple-docs mcp serve --port 3031 # Streamable HTTP server
Nine read-only tools: search_docs, read_doc, list_frameworks, browse,
list_taxonomy, search_sf_symbols, list_apple_fonts, render_sf_symbol,
render_font_text — plus resources for docs, frameworks, SF Symbol renders,
and font files.
The tool surface is deliberately context-cheap: definitions cost ~2.2k tokens total (about a quarter of a typical multi-tool MCP server), responses are compact JSON with pagination built in, and a CI budget test keeps it that way. Your context window stays available for actual work.
HTTP mode has no built-in auth — keep it on loopback unless a reverse proxy or tunnel handles access control.
Public instance
A best-effort public deployment (no uptime SLA; self-host for production):
claude mcp add -s user --transport http apple-docs https://apple-docs-mcp.everest.mt/mcp
codex mcp add apple-docs -- bunx mcp-remote https://apple-docs-mcp.everest.mt/mcp
Local website
apple-docs web serve # http://127.0.0.1:3000
apple-docs web build --out dist/web # static site
The server is agent-friendly out of the box: append .md to any doc URL for
Markdown (/docs/swiftui/view.md), and discovery endpoints are served at
/robots.txt, /.well-known/api-catalog (RFC 9727), and
/.well-known/mcp/server-card.json. Deployment recipes:
apple-docs web deploy <github-pages|cloudflare|vercel|netlify> and
docs/self-hosting.md.
Keeping it fresh
Snapshots are rebuilt weekly by CI. To update, re-run:
apple-docs setup --force
Running a newer macOS than CI? apple-docs setup --beta --force opts into
prerelease snapshots built on developer machines, which carry SF Symbols the
stable CI builds can't produce yet
(details).
Or skip snapshots entirely and crawl Apple's docs yourself:
apple-docs sync # resumable, idempotent refresh
apple-docs sync --full # clean rebuild
sync runs the whole pipeline with the network features on by default:
Apple's font DMGs, the embedding model, and Xcode's offline documentation
asset (USRs and a few thousand pages the public crawl can't see — from a
local Xcode install when present, else a ~650 MB cached CDN download). It
finishes by refreshing the semantic index so newly enriched pages are
searchable. Opt out per run with --no-download-fonts, --no-fetch-models,
or --no-enrich-fetch.
Build your own portable snapshot with apple-docs snapshot build --out dist,
install it with apple-docs setup --archive <path>.
Scoping the corpus (optional)
The full corpus is ~4.6–10.5 GB on disk depending on the storage profile.
If you only need a slice of it, drop a
scope.json into your data directory (default ~/.apple-docs) saying what
to keep:
{
"version": 1,
"sources": ["apple-docc", "hig", "swift-book"],
"appleDoccFrameworks": ["swiftui", "combine"],
"keepFonts": true,
"keepSymbols": false
}
Every field is optional except version — omit sources to keep all
sources, omit appleDoccFrameworks to keep every framework. Then:
apple-docs prune --dry-run # preview what would be removed
apple-docs prune # trim the existing corpus, reclaim disk
prune deletes the out-of-scope pages (search indexes, semantic vectors,
and on-disk files included) without re-crawling anything, and future
apple-docs sync runs read the same file so the corpus stays scoped.
Delete scope.json and sync to grow back to full coverage. No
scope.json means nothing changes — full coverage is the default.
What's in the corpus
| Source | Coverage |
|---|---|
apple-docc |
API reference: frameworks, technologies, release notes |
hig |
Human Interface Guidelines |
guidelines |
App Store Review Guidelines |
swift-evolution |
Swift Evolution proposals |
swift-book |
The Swift Programming Language |
swift-docc |
Swift toolchain docs (compiler, SwiftPM, migration guides) |
swift-org |
Swift.org documentation and articles |
apple-archive |
Archived Apple developer documentation |
wwdc |
WWDC sessions with transcripts, browsable by year |
sample-code |
Apple sample code catalog |
packages |
Swift package catalog with README content |
Development
bun run ci # lint + typecheck + tests
bun run audit # + unused code, duplication, coverage
bun scripts/verify-profiles.mjs # full integration matrix: installs every
# storage profile from the latest snapshot
# and exercises CLI + web + MCP against each
More docs: architecture · configuration · installing · self-hosting · performance · security · index
License
MIT.
apple-docs MCP questions
Does this work offline?
Yes, once the setup is complete, everything works offline.
How much disk space does it require?
The disk usage depends on the storage profile chosen: ~4.6 GB for compact, ~7.1 GB for default, or ~10.5 GB for fastest reads.
What kind of documentation is included?
It includes Apple's API reference, Human Interface Guidelines, App Store Review Guidelines, Swift Evolution, WWDC sessions, and more.
Does the MCP server require an API key?
No, it uses a local semantic index that requires no cloud or API key.