Skip to content

adv3nt3/apple-docs-mcp

 
 

Repository files navigation

Apple Docs MCP - Apple Developer Documentation Model Context Protocol Server

npm version License: MIT

Apple Developer Documentation MCP Server - Access Apple's official developer docs, frameworks, APIs, SwiftUI, UIKit, and WWDC videos through Model Context Protocol. Search iOS, macOS, watchOS, tvOS, and visionOS documentation with AI-powered natural language queries. Get instant access to Swift/Objective-C code examples, API references, and technical guides directly in Claude, Cursor, or any MCP-compatible AI assistant.

English | 日本語 | 한국어 | 简体中文

✨ Features

  • 🔍 Smart Search: Intelligent search across Apple Developer Documentation for SwiftUI, UIKit, Foundation, CoreData, ARKit, and more
  • 📚 Complete Documentation Access: Full access to Apple's JSON API for Swift, Objective-C, and framework documentation
  • 🔧 Framework Index: Browse hierarchical API structures for iOS, macOS, watchOS, tvOS, visionOS frameworks
  • 📋 Technology Catalog: Explore Apple technologies including SwiftUI, UIKit, Metal, Core ML, Vision, and ARKit
  • 📰 Documentation Updates: Track WWDC 2024/2025 announcements, iOS 26, macOS 26, and latest SDK releases
  • 🎯 Technology Overviews: Comprehensive guides for Swift, SwiftUI, UIKit, and all Apple development platforms
  • 💻 Sample Code Library: Swift and Objective-C code examples for iOS, macOS, and cross-platform development
  • 🎥 WWDC Video Library: Search WWDC 2014-2025 sessions with transcripts, Swift/SwiftUI code examples, and resources
  • 🔗 Related APIs Discovery: Find SwiftUI views, UIKit controllers, and framework-specific API relationships
  • 📊 Platform Compatibility: iOS 13+, macOS 10.15+, watchOS 6+, tvOS 13+, visionOS compatibility analysis
  • High Performance: Optimized for Xcode, Swift Playgrounds, and AI-powered development environments
  • 🔄 Smart UserAgent Pool: Intelligent UserAgent rotation system with automatic failure recovery and performance monitoring
  • 🌐 Multi-Platform: Complete iOS, iPadOS, macOS, watchOS, tvOS, and visionOS documentation support
  • 🏷️ Beta & Status Tracking: iOS 26 beta APIs, deprecated UIKit methods, new SwiftUI features tracking

🚀 Quick Start

Heads up: @adv3nt3/apple-docs-mcp has not been published to npm yet, so the npx snippets shown in older docs will 404. Build from source until the first npm release ships. The original npx-style snippets are preserved at the bottom of the install section under Once published to npm for future reference.

1. Build from source

git clone https://github.com/adv3nt3/apple-docs-mcp.git
cd apple-docs-mcp
pnpm install --frozen-lockfile
pnpm run build

pnpm run build runs tsc and copies the bundled WWDC corpus into dist/. The compiled entry point is dist/index.js.

2. Wire it into your MCP host

Replace /absolute/path/to/apple-docs-mcp with the path you cloned into.

Claude Desktop~/Library/Application Support/Claude/claude_desktop_config.json (macOS) or %APPDATA%\Claude\claude_desktop_config.json (Windows):

{
  "mcpServers": {
    "apple-docs": {
      "command": "node",
      "args": ["/absolute/path/to/apple-docs-mcp/dist/index.js"]
    }
  }
}

Restart Claude Desktop and start asking about Apple APIs.

📦 Installation

Every host below uses the same pattern: point command: "node" at the absolute path to your local dist/index.js.

📱 Claude Code
claude mcp add apple-docs -- node /absolute/path/to/apple-docs-mcp/dist/index.js

📖 Claude Code MCP docs

🖱️ Cursor

Via Settings: Settings → Cursor Settings → MCP → Add new global MCP server

Via Config File: Add to ~/.cursor/mcp.json:

{
  "mcpServers": {
    "apple-docs": {
      "command": "node",
      "args": ["/absolute/path/to/apple-docs-mcp/dist/index.js"]
    }
  }
}

📖 Cursor MCP docs

🔷 VS Code

Add to your VS Code MCP config:

{
  "mcp": {
    "servers": {
      "apple-docs": {
        "type": "stdio",
        "command": "node",
        "args": ["/absolute/path/to/apple-docs-mcp/dist/index.js"]
      }
    }
  }
}

📖 VS Code MCP docs

🌊 Windsurf

Add to your Windsurf MCP config:

{
  "mcpServers": {
    "apple-docs": {
      "command": "node",
      "args": ["/absolute/path/to/apple-docs-mcp/dist/index.js"]
    }
  }
}

📖 Windsurf MCP docs

⚡ Zed

Add to your Zed settings.json:

{
  "context_servers": {
    "Apple Docs": {
      "command": {
        "path": "node",
        "args": ["/absolute/path/to/apple-docs-mcp/dist/index.js"]
      },
      "settings": {}
    }
  }
}

📖 Zed Context Server docs

🔧 Cline

Add to cline_mcp_settings.json:

{
  "mcpServers": {
    "apple-docs": {
      "command": "node",
      "args": ["/absolute/path/to/apple-docs-mcp/dist/index.js"],
      "disabled": false,
      "autoApprove": []
    }
  }
}
Amazon Q Developer CLI

Add to ~/.aws/amazonq/mcp.json:

{
  "mcpServers": {
    "apple-docs": {
      "command": "node",
      "args": ["/absolute/path/to/apple-docs-mcp/dist/index.js"]
    }
  }
}

📖 Amazon Q Developer CLI MCP docs

🪟 Windows

The same node invocation works on Windows once you swap the path separators. Either escape backslashes:

{
  "mcpServers": {
    "apple-docs": {
      "command": "node",
      "args": ["C:\\path\\to\\apple-docs-mcp\\dist\\index.js"]
    }
  }
}

…or use forward slashes — Node accepts both.

⚙️ Once published to npm

The snippets below are preserved for the day @adv3nt3/apple-docs-mcp is first published to npm. They do not work todaynpx will fail with a 404 until the package exists on the registry.

Claude Desktop / Cursor / Windsurf / Cline / Amazon Q / VS Code (all same pattern):

{
  "mcpServers": {
    "apple-docs": {
      "command": "npx",
      "args": ["-y", "@adv3nt3/apple-docs-mcp"]
    }
  }
}

Claude Code:

claude mcp add apple-docs -- npx -y @adv3nt3/apple-docs-mcp@latest

Windows:

{
  "mcpServers": {
    "apple-docs": {
      "command": "cmd",
      "args": ["/c", "npx", "-y", "@adv3nt3/apple-docs-mcp"],
      "disabled": false,
      "autoApprove": []
    }
  }
}

Global installation (after publish):

pnpm add -g @adv3nt3/apple-docs-mcp   # or: npm install -g @adv3nt3/apple-docs-mcp

💬 Usage Examples

🔍 Smart Search

"Search for SwiftUI animations"
"Find withAnimation API documentation"
"Look up async/await patterns in Swift"
"Show me UITableView delegate methods"
"Search Core Data NSPersistentContainer examples"
"Find AVFoundation video playback APIs"

📚 Documentation Access

"Get detailed information about the SwiftUI framework"
"Show me withAnimation API with related APIs"
"Get platform compatibility for SwiftData"
"Access UIViewController documentation with similar APIs"
"Show me NSManagedObjectContext documentation"
"Get URLSession async/await methods"

🔧 Framework Exploration

"Show me SwiftUI framework API index"
"List all UIKit classes and methods"
"Browse ARKit framework structure"
"Get WeatherKit API hierarchy"
"Explore Core ML model loading APIs"
"Show Vision framework image analysis APIs"

🔗 API Discovery

"Find APIs related to UIViewController"
"Show me similar APIs to withAnimation"
"Get all references from SwiftData documentation"
"Discover alternatives to Core Data NSManagedObject"

📋 Technology & Platform Analysis

"List all Beta frameworks in iOS 26"
"Show me Graphics & Games technologies"
"What machine learning frameworks are available?"
"Analyze platform compatibility for Vision framework"

📰 Documentation Updates

"Show me the latest WWDC updates"
"What's new in SwiftUI?"
"Get technology updates for iOS"
"Show me release notes for Xcode"
"Find beta features in the latest updates"

🎯 Technology Overviews

"Show me technology overviews for app design and UI"
"Get comprehensive guides for games development"
"Explore AI and machine learning overviews"
"Show me iOS-specific technology guides"
"Get data management technology overviews"

💻 Sample Code Library

"Show SwiftUI sample code projects"
"Find sample code for machine learning"
"Get UIKit example projects"
"Show featured WWDC sample code"
"Find Core Data sample implementations"
"Show only beta sample code projects"

🎥 WWDC Video Search

"Search WWDC videos about SwiftUI"
"Find WWDC sessions on machine learning"
"Show me WWDC 2024 videos"
"Search for async/await WWDC talks"
"Find WWDC videos about Swift concurrency"
"Show accessibility-focused WWDC sessions"

📺 WWDC Video Details

"Get details for WWDC session 10176"
"Show me the transcript for WWDC23 session on SwiftData"
"Get code examples from WWDC video 10019"
"Show resources from Vision Pro WWDC session"
"Get transcript for 'Meet async/await in Swift' session"

📋 WWDC Topics & Years

"List all WWDC topics"
"Show me Swift topic WWDC videos"
"Get WWDC videos about developer tools"
"List WWDC videos from 2023"
"Show all SwiftUI and UI frameworks sessions"
"Get machine learning WWDC content"

🛠️ Advanced Usage

"Find related APIs for @State with platform analysis"
"Resolve all references from SwiftUI documentation"
"Get platform compatibility analysis for Vision framework"
"Find similar APIs to UIViewController with deep search"

🛠️ Available Tools

Tool Description Key Features
search_apple_docs Search Apple Developer Documentation Official search API, find specific APIs, classes, methods
get_apple_doc_content Get detailed documentation content JSON API access, optional enhanced analysis (related/similar APIs, platform compatibility)
list_technologies Browse all Apple technologies Category filtering, language support, beta status
search_framework_symbols Search symbols in specific framework Classes, structs, protocols, wildcard patterns, type filtering
get_related_apis Find related APIs Inheritance, conformance, "See Also" relationships
resolve_references_batch Batch resolve API references Extract and resolve all references from documentation
get_platform_compatibility Platform compatibility analysis Version support, beta status, deprecation info
find_similar_apis Discover similar APIs Apple's official recommendations, topic groupings
get_documentation_updates Track Apple documentation updates WWDC announcements, technology updates, release notes
get_technology_overviews Get technology overviews and guides Comprehensive guides, hierarchical navigation, platform filtering
get_sample_code Browse Apple sample code projects Framework filtering (with limitations), keyword search, beta status
search_wwdc_videos Search WWDC video sessions Keyword search, topic/year filtering, session metadata
get_wwdc_video_details Get WWDC video details with transcript Full transcripts, code examples, resources, platform info
list_wwdc_topics List all available WWDC topics 19 topic categories from Swift to Spatial Computing
list_wwdc_years List all available WWDC years Conference years with video counts

🏗️ Technical Architecture for Apple Developer Documentation Access

apple-docs-mcp/
├── 🔧 src/
│   ├── index.ts                      # MCP server entry point with all tools
│   ├── tools/                        # MCP tool implementations
│   │   ├── search-parser.ts          # HTML search result parsing
│   │   ├── doc-fetcher.ts            # JSON API documentation fetching
│   │   ├── list-technologies.ts      # Technology catalog handling
│   │   ├── get-documentation-updates.ts # Documentation updates tracking
│   │   ├── get-technology-overviews.ts # Technology overviews and guides
│   │   ├── get-sample-code.ts        # Sample code library browser
│   │   ├── get-framework-index.ts    # Framework structure indexing
│   │   ├── get-related-apis.ts       # Related API discovery
│   │   ├── resolve-references-batch.ts # Batch reference resolution
│   │   ├── get-platform-compatibility.ts # Platform analysis
│   │   ├── find-similar-apis.ts      # Similar API recommendations
│   │   └── wwdc/                     # WWDC video tools
│   │       ├── wwdc-handlers.ts      # WWDC tool handlers
│   │       ├── content-extractor.ts  # Video content extraction
│   │       ├── topics-extractor.ts   # Topic listing
│   │       └── video-list-extractor.ts # Video list parsing
│   └── utils/                        # Utility functions and helpers
│       ├── cache.ts                  # Memory cache with TTL support
│       ├── constants.ts              # Application constants and URLs
│       ├── error-handler.ts          # Error handling and validation
│       ├── http-client.ts            # HTTP client with performance tracking
│       ├── user-agent-pool.ts        # Smart UserAgent rotation system
│       ├── http-headers-generator.ts # Dynamic browser headers generation
│       └── url-converter.ts          # URL conversion utilities
├── 📦 dist/                          # Compiled JavaScript
├── 📄 package.json                   # Package configuration
└── 📖 README.md                      # This file

🚀 Performance Features

  • Memory-Based Caching: Custom cache implementation with automatic cleanup and TTL support
  • Smart UserAgent Pool: Intelligent rotation system with automatic failure recovery and performance monitoring
  • Dynamic Headers: Realistic browser headers generation (Accept, Accept-Language, User-Agent)
  • Smart Search: Official Apple search API with enhanced result formatting
  • Enhanced Analysis: Optional related APIs, platform compatibility, and similarity analysis
  • Error Resilience: Graceful degradation with comprehensive error handling
  • Type Safety: Full TypeScript with Zod v4.0.5 runtime validation
  • Latest Dependencies: MCP SDK v1.15.1, optimized package footprint

💾 Caching Strategy

Content Type Cache Duration Cache Size Reason
API Documentation 30 minutes 500 entries Frequently accessed, moderate updates
Search Results 10 minutes 200 entries Dynamic content, user-specific
Framework Indexes 1 hour 100 entries Stable structure, less frequent changes
Technologies List 2 hours 50 entries Rarely changes, large content
Documentation Updates 30 minutes 100 entries Regular updates, WWDC announcements

📦 WWDC Data

All WWDC video data (2014-2025) is bundled directly in the npm package, providing:

  • Zero network latency - No API calls needed for WWDC content
  • 100% offline access - Works without internet connection
  • No rate limits - Unlimited WWDC searches and browsing
  • Instant responses - All data is locally available

The package includes:

  • 📹 1,260+ WWDC session videos with full transcripts
  • 🏷️ 20 topic categories for organized browsing
  • 📅 13 years of content (2012-2025)
  • 💾 35MB of optimized JSON data

Note: Keep your package updated to get the latest WWDC content additions.

⚙️ Configuration

🔄 UserAgent Pool

The server ships with a built-in pool of Safari User-Agent strings (see src/utils/constants.ts) and rotates them automatically on each request. The pool itself is not user-configurable at runtime.

HTTP Header Environment Variables

The following environment variables (consumed in src/utils/http-client.ts) tune the headers attached to outbound requests:

Variable Description Default
DISABLE_SEC_FETCH Set to true to omit Sec-Fetch-* headers false
DISABLE_DNT Set to true to omit the DNT header false
DISABLE_LANGUAGE_ROTATION Set to true to disable Accept-Language rotation false
SIMPLE_HEADERS_MODE Set to true to send a minimal header set false
DEFAULT_ACCEPT_LANGUAGE Override the default Accept-Language value en-US,en;q=0.9

Logging & Diagnostics Environment Variables

Variable Description Default
MCP_LOG_LEVEL Minimum log level emitted on stderr (debug, info, warn, error; case-insensitive) info
MCP_DEBUG Set to true to enable debug-level messages (in addition to MCP_LOG_LEVEL) false
MCP_DIAGNOSTICS Set to true to expose the get_performance_report and get_cache_stats operator tools via tools/list false

Operator diagnostics

The server ships with two operator-grade diagnostic tools — get_performance_report and get_cache_stats — that surface HTTP client metrics, cache hit rates, framework preload status, and rate limiter state. These are useful for humans debugging the server but aren't actionable for AI assistants, so they're hidden from tools/list by default. Set MCP_DIAGNOSTICS=true in the server's environment (e.g., add "env": { "MCP_DIAGNOSTICS": "true" } to your MCP host config) to register them.

🧪 Development

Quick Commands

# Development with auto-reload
pnpm run dev    # or: npm run dev

# Build for production  
pnpm run build  # or: npm run build

# Type checking
pnpm exec tsc --noEmit  # or: npx tsc --noEmit

# Clean build artifacts
pnpm run clean  # or: npm run clean

Testing Locally

# Test the MCP server directly
node dist/index.js

# Test with sample queries
npx @adv3nt3/apple-docs-mcp --test

🤝 Contributing

Contributions are welcome! Here's how to get started:

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/amazing-feature
  3. Commit your changes: git commit -m 'Add amazing feature'
  4. Push to the branch: git push origin feature/amazing-feature
  5. Open a Pull Request

📄 License

MIT License - see LICENSE for details.

⚠️ Disclaimer

This project is not affiliated with or endorsed by Apple Inc. It uses publicly available Apple Developer Documentation APIs for educational and development purposes.


Made with ❤️ for the Apple Developer Community

Search Apple Developer Documentation | iOS Development | macOS Development | Swift Programming | SwiftUI | UIKit | Xcode | WWDC Videos | Model Context Protocol | MCP Server

Report IssuesRequest FeaturesDocumentation

About

MCP server for Apple Developer Documentation - Search iOS/macOS/SwiftUI/UIKit docs, WWDC videos, Swift/Objective-C APIs & code examples in Claude, Cursor & AI assistants

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • TypeScript 98.8%
  • JavaScript 1.2%