Skip to content
Back to search

apple-docs-mcp

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

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/kimsungwhee--apple-docs-mcp/badge.svg)](/listings/kimsungwhee--apple-docs-mcp)

HTML

<a href="/listings/kimsungwhee--apple-docs-mcp"><img src="/api/listings/kimsungwhee--apple-docs-mcp/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

Claude Desktop (Recommended)

Add this to your Claude Desktop configuration:

**macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json` **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`

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

> **Note**: If you encounter issues with an old version being used, add `@latest` to force the latest version: > ```json > "args": ["-y", "@kimsungwhee/apple-docs-mcp@latest"] > ```

Restart Claude Desktop and start asking about Apple APIs!

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 558 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. # Apple Docs MCP - Apple Developer Documentation Model Context Protocol Server
  2. [![npm version](https://badge.fury.io/js/@kimsungwhee%2Fapple-docs-mcp.svg)](https://badge.fury.io/js/@kimsungwhee%2Fapple-docs-mcp)
  3. [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
  4. 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.
  5. **English** | [日本語](README.ja.md) | [한국어](README.ko.md) | [简体中文](README.zh-CN.md)
  6. ## ✨ Features
  7. - 🔍 **Smart Search**: Intelligent search across Apple Developer Documentation for SwiftUI, UIKit, Foundation, CoreData, ARKit, and more
  8. - 📚 **Complete Documentation Access**: Full access to Apple's JSON API for Swift, Objective-C, and framework documentation
  9. - 🔧 **Framework Index**: Browse hierarchical API structures for iOS, macOS, watchOS, tvOS, visionOS frameworks
  10. - 📋 **Technology Catalog**: Explore Apple technologies including SwiftUI, UIKit, Metal, Core ML, Vision, and ARKit
  11. - 📰 **Documentation Updates**: Track WWDC 2024/2025 announcements, iOS 26, macOS 26, and latest SDK releases
  12. - 🎯 **Technology Overviews**: Comprehensive guides for Swift, SwiftUI, UIKit, and all Apple development platforms
  13. - 💻 **Sample Code Library**: Swift and Objective-C code examples for iOS, macOS, and cross-platform development
  14. - 🎥 **WWDC Video Library**: Search WWDC 2014-2025 sessions with transcripts, Swift/SwiftUI code examples, and resources
  15. - 🔗 **Related APIs Discovery**: Find SwiftUI views, UIKit controllers, and framework-specific API relationships
  16. - 📊 **Platform Compatibility**: iOS 13+, macOS 10.15+, watchOS 6+, tvOS 13+, visionOS compatibility analysis
  17. - ⚡ **High Performance**: Optimized for Xcode, Swift Playgrounds, and AI-powered development environments
  18. - 🔄 **Smart UserAgent Pool**: Intelligent UserAgent rotation system with automatic failure recovery and performance monitoring
  19. - 🌐 **Multi-Platform**: Complete iOS, iPadOS, macOS, watchOS, tvOS, and visionOS documentation support
  20. - 🏷️ **Beta & Status Tracking**: iOS 26 beta APIs, deprecated UIKit methods, new SwiftUI features tracking
  21. ## 🚀 Quick Start
  22. ### Claude Desktop (Recommended)
  23. Add this to your Claude Desktop configuration:
  24. **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
  25. **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
  26. ```json
  27. {
  28. "mcpServers": {
  29. "apple-docs": {
  30. "command": "npx",
  31. "args": ["-y", "@kimsungwhee/apple-docs-mcp"]
  32. }
  33. }
  34. }
  35. ```
  36. > **Note**: If you encounter issues with an old version being used, add `@latest` to force the latest version:
  37. > ```json
  38. > "args": ["-y", "@kimsungwhee/apple-docs-mcp@latest"]
  39. > ```
  40. Restart Claude Desktop and start asking about Apple APIs!
  41. ## 📦 Installation
  42. <details>
  43. <summary><strong>📱 Claude Code</strong></summary>
  44. ```bash
  45. claude mcp add apple-docs -- npx -y @kimsungwhee/apple-docs-mcp@latest
  46. ```
  47. [📖 Claude Code MCP docs](https://docs.anthropic.com/en/docs/claude-code/mcp)
  48. </details>
  49. <details>
  50. <summary><strong>🖱️ Cursor</strong></summary>
  51. **Via Settings**: Settings → Cursor Settings → MCP → Add new global MCP server
  52. **Via Config File**: Add to `~/.cursor/mcp.json`:
  53. ```json
  54. {
  55. "mcpServers": {
  56. "apple-docs": {
  57. "command": "npx",
  58. "args": ["-y", "@kimsungwhee/apple-docs-mcp"]
  59. }
  60. }
  61. }
  62. ```
  63. [📖 Cursor MCP docs](https://docs.cursor.com/context/mcp)
  64. </details>
  65. <details>
  66. <summary><strong>🔷 VS Code</strong></summary>
  67. Add to your VS Code MCP config:
  68. ```json
  69. {
  70. "mcp": {
  71. "servers": {
  72. "apple-docs": {
  73. "type": "stdio",
  74. "command": "npx",
  75. "args": ["-y", "@kimsungwhee/apple-docs-mcp"]
  76. }
  77. }
  78. }
  79. }
  80. ```
  81. [📖 VS Code MCP docs](https://code.visualstudio.com/docs/editor/mcp)
  82. </details>
  83. <details>
  84. <summary><strong>🌊 Windsurf</strong></summary>
  85. Add to your Windsurf MCP config:
  86. ```json
  87. {
  88. "mcpServers": {
  89. "apple-docs": {
  90. "command": "npx",
  91. "args": ["-y", "@kimsungwhee/apple-docs-mcp"]
  92. }
  93. }
  94. }
  95. ```
  96. [📖 Windsurf MCP docs](https://docs.codeium.com/windsurf/mcp)
  97. </details>
  98. <details>
  99. <summary><strong>⚡ Zed</strong></summary>
  100. Add to your Zed `settings.json`:
  101. ```json
  102. {
  103. "context_servers": {
  104. "Apple Docs": {
  105. "command": {
  106. "path": "npx",
  107. "args": ["-y", "@kimsungwhee/apple-docs-mcp"]
  108. },
  109. "settings": {}
  110. }
  111. }
  112. }
  113. ```
  114. [📖 Zed Context Server docs](https://zed.dev/docs/context-servers)
  115. </details>
  116. <details>
  117. <summary><strong>🔧 Cline</strong></summary>
  118. **Via Marketplace**:
  119. 1. Open Cline → Menu (☰) → MCP Servers → Marketplace
  120. 2. Search "Apple Docs MCP" → Install
  121. **Via Config**: Add to `cline_mcp_settings.json`:
  122. ```json
  123. {
  124. "mcpServers": {
  125. "apple-docs": {
  126. "command": "npx",
  127. "args": ["-y", "@kimsungwhee/apple-docs-mcp"],
  128. "disabled": false,
  129. "autoApprove": []
  130. }
  131. }
  132. }
  133. ```
  134. </details>
  135. <details>
  136. <summary><strong> Amazon A Developer CLI</strong></summary>
  137. **Via Config File**: Add to `~/.aws/amazonq/mcp.json`:
  138. ```json
  139. {
  140. "mcpServers": {
  141. "apple-docs": {
  142. "command": "npx",
  143. "args": ["-y", "@kimsungwhee/apple-docs-mcp"]
  144. }
  145. }
  146. }
  147. ```
  148. [📖 Amazon A Developer CLI MCP docs](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/qdev-mcp.html)
  149. </details>
  150. <details>
  151. <summary><strong>🪟 Windows</strong></summary>
  152. For Windows systems, use:
  153. ```json
  154. {
  155. "mcpServers": {
  156. "apple-docs": {
  157. "command": "cmd",
  158. "args": ["/c", "npx", "-y", "@kimsungwhee/apple-docs-mcp"],
  159. "disabled": false,
  160. "autoApprove": []
  161. }
  162. }
  163. }
  164. ```
  165. </details>
  166. <details>
  167. <summary><strong>⚙️ Advanced Installation</strong></summary>
  168. **Global Installation**:
  169. ```bash
  170. # Using pnpm (recommended)
  171. pnpm add -g @kimsungwhee/apple-docs-mcp
  172. # Using npm
  173. npm install -g @kimsungwhee/apple-docs-mcp
  174. ```
  175. **Direct Usage**:
  176. ```bash
  177. npx @kimsungwhee/apple-docs-mcp --help
  178. ```
  179. **Development Setup**:
  180. ```bash
  181. git clone https://github.com/kimsungwhee/apple-docs-mcp.git
  182. cd apple-docs-mcp
  183. # Using pnpm (recommended)
  184. pnpm install && pnpm run build
  185. # Using npm
  186. npm install && npm run build
  187. ```
  188. </details>
  189. ## 💬 Usage Examples
  190. ### 🔍 Smart Search
  191. ```
  192. "Search for SwiftUI animations"
  193. "Find withAnimation API documentation"
  194. "Look up async/await patterns in Swift"
  195. "Show me UITableView delegate methods"
  196. "Search Core Data NSPersistentContainer examples"
  197. "Find AVFoundation video playback APIs"
  198. ```
  199. ### 📚 Documentation Access
  200. ```
  201. "Get detailed information about the SwiftUI framework"
  202. "Show me withAnimation API with related APIs"
  203. "Get platform compatibility for SwiftData"
  204. "Access UIViewController documentation with similar APIs"
  205. "Show me NSManagedObjectContext documentation"
  206. "Get URLSession async/await methods"
  207. ```
  208. ### 🔧 Framework Exploration
  209. ```
  210. "Show me SwiftUI framework API index"
  211. "List all UIKit classes and methods"
  212. "Browse ARKit framework structure"
  213. "Get WeatherKit API hierarchy"
  214. "Explore Core ML model loading APIs"
  215. "Show Vision framework image analysis APIs"
  216. ```
  217. ### 🔗 API Discovery
  218. ```
  219. "Find APIs related to UIViewController"
  220. "Show me similar APIs to withAnimation"
  221. "Get all references from SwiftData documentation"
  222. "Discover alternatives to Core Data NSManagedObject"
  223. ```
  224. ### 📋 Technology & Platform Analysis
  225. ```
  226. "List all Beta frameworks in iOS 26"
  227. "Show me Graphics & Games technologies"
  228. "What machine learning frameworks are available?"
  229. "Analyze platform compatibility for Vision framework"
  230. ```
  231. ### 📰 Documentation Updates
  232. ```
  233. "Show me the latest WWDC updates"
  234. "What's new in SwiftUI?"
  235. "Get technology updates for iOS"
  236. "Show me release notes for Xcode"
  237. "Find beta features in the latest updates"
  238. ```
  239. ### 🎯 Technology Overviews
  240. ```
  241. "Show me technology overviews for app design and UI"
  242. "Get comprehensive guides for games development"
  243. "Explore AI and machine learning overviews"
  244. "Show me iOS-specific technology guides"
  245. "Get data management technology overviews"
  246. ```
  247. ### 💻 Sample Code Library
  248. ```
  249. "Show SwiftUI sample code projects"
  250. "Find sample code for machine learning"
  251. "Get UIKit example projects"
  252. "Show featured WWDC sample code"
  253. "Find Core Data sample implementations"
  254. "Show only beta sample code projects"
  255. ```
  256. ### 🎥 WWDC Video Search
  257. ```
  258. "Search WWDC videos about SwiftUI"
  259. "Find WWDC sessions on machine learning"
  260. "Show me WWDC 2024 videos"
  261. "Search for async/await WWDC talks"
  262. "Find WWDC videos about Swift concurrency"
  263. "Show accessibility-focused WWDC sessions"
  264. ```
  265. ### 📺 WWDC Video Details
  266. ```
  267. "Get details for WWDC session 10176"
  268. "Show me the transcript for WWDC23 session on SwiftData"
  269. "Get code examples from WWDC video 10019"
  270. "Show resources from Vision Pro WWDC session"
  271. "Get transcript for 'Meet async/await in Swift' session"
  272. ```
  273. ### 📋 WWDC Topics & Years
  274. ```
  275. "List all WWDC topics"
  276. "Show me Swift topic WWDC videos"
  277. "Get WWDC videos about developer tools"
  278. "List WWDC videos from 2023"
  279. "Show all SwiftUI and UI frameworks sessions"
  280. "Get machine learning WWDC content"
  281. ```
  282. ### 🛠️ Advanced Usage
  283. ```
  284. "Find related APIs for @State with platform analysis"
  285. "Resolve all references from SwiftUI documentation"
  286. "Get platform compatibility analysis for Vision framework"
  287. "Find similar APIs to UIViewController with deep search"
  288. ```
  289. ## 🛠️ Available Tools
  290. | Tool | Description | Key Features |
  291. |------|-------------|--------------|
  292. | `search_apple_docs` | Search Apple Developer Documentation | Official search API, find specific APIs, classes, methods |
  293. | `get_apple_doc_content` | Get detailed documentation content | JSON API access, optional enhanced analysis (related/similar APIs, platform compatibility) |
  294. | `list_technologies` | Browse all Apple technologies | Category filtering, language support, beta status |
  295. | `search_framework_symbols` | Search symbols in specific framework | Classes, structs, protocols, wildcard patterns, type filtering |
  296. | `get_related_apis` | Find related APIs | Inheritance, conformance, "See Also" relationships |
  297. | `resolve_references_batch` | Batch resolve API references | Extract and resolve all references from documentation |
  298. | `get_platform_compatibility` | Platform compatibility analysis | Version support, beta status, deprecation info |
  299. | `find_similar_apis` | Discover similar APIs | Apple's official recommendations, topic groupings |
  300. | `get_documentation_updates` | Track Apple documentation updates | WWDC announcements, technology updates, release notes |
  301. | `get_technology_overviews` | Get technology overviews and guides | Comprehensive guides, hierarchical navigation, platform filtering |
  302. | `get_sample_code` | Browse Apple sample code projects | Framework filtering (with limitations), keyword search, beta status |
  303. | `search_wwdc_videos` | Search WWDC video sessions | Keyword search, topic/year filtering, session metadata |
  304. | `get_wwdc_video_details` | Get WWDC video details with transcript | Full transcripts, code examples, resources, platform info |
  305. | `list_wwdc_topics` | List all available WWDC topics | 19 topic categories from Swift to Spatial Computing |
  306. | `list_wwdc_years` | List all available WWDC years | Conference years with video counts |
  307. ## 🏗️ Technical Architecture for Apple Developer Documentation Access
  308. ```
  309. apple-docs-mcp/
  310. ├── 🔧 src/
  311. │ ├── index.ts # MCP server entry point with all tools
  312. │ ├── tools/ # MCP tool implementations
  313. │ │ ├── search-parser.ts # HTML search result parsing
  314. │ │ ├── doc-fetcher.ts # JSON API documentation fetching
  315. │ │ ├── list-technologies.ts # Technology catalog handling
  316. │ │ ├── get-documentation-updates.ts # Documentation updates tracking
  317. │ │ ├── get-technology-overviews.ts # Technology overviews and guides
  318. │ │ ├── get-sample-code.ts # Sample code library browser
  319. │ │ ├── get-framework-index.ts # Framework structure indexing
  320. │ │ ├── get-related-apis.ts # Related API discovery
  321. │ │ ├── resolve-references-batch.ts # Batch reference resolution
  322. │ │ ├── get-platform-compatibility.ts # Platform analysis
  323. │ │ ├── find-similar-apis.ts # Similar API recommendations
  324. │ │ └── wwdc/ # WWDC video tools
  325. │ │ ├── wwdc-handlers.ts # WWDC tool handlers
  326. │ │ ├── content-extractor.ts # Video content extraction
  327. │ │ ├── topics-extractor.ts # Topic listing
  328. │ │ └── video-list-extractor.ts # Video list parsing
  329. │ └── utils/ # Utility functions and helpers
  330. │ ├── cache.ts # Memory cache with TTL support
  331. │ ├── constants.ts # Application constants and URLs
  332. │ ├── error-handler.ts # Error handling and validation
  333. │ ├── http-client.ts # HTTP client with performance tracking
  334. │ ├── user-agent-pool.ts # Smart UserAgent rotation system
  335. │ ├── http-headers-generator.ts # Dynamic browser headers generation
  336. │ └── url-converter.ts # URL conversion utilities
  337. ├── 📦 dist/ # Compiled JavaScript
  338. ├── 📄 package.json # Package configuration
  339. └── 📖 README.md # This file
  340. ```
  341. ### 🚀 Performance Features
  342. - **Memory-Based Caching**: Custom cache implementation with automatic cleanup and TTL support
  343. - **Smart UserAgent Pool**: Intelligent rotation system with automatic failure recovery and performance monitoring
  344. - **Dynamic Headers**: Realistic browser headers generation (Accept, Accept-Language, User-Agent)
  345. - **Smart Search**: Official Apple search API with enhanced result formatting
  346. - **Enhanced Analysis**: Optional related APIs, platform compatibility, and similarity analysis
  347. - **Error Resilience**: Graceful degradation with comprehensive error handling
  348. - **Type Safety**: Full TypeScript with Zod v4.0.5 runtime validation
  349. - **Latest Dependencies**: MCP SDK v1.15.1, optimized package footprint
  350. ### 💾 Caching Strategy
  351. | Content Type | Cache Duration | Cache Size | Reason |
  352. |--------------|----------------|------------|--------|
  353. | API Documentation | 30 minutes | 500 entries | Frequently accessed, moderate updates |
  354. | Search Results | 10 minutes | 200 entries | Dynamic content, user-specific |
  355. | Framework Indexes | 1 hour | 100 entries | Stable structure, less frequent changes |
  356. | Technologies List | 2 hours | 50 entries | Rarely changes, large content |
  357. | Documentation Updates | 30 minutes | 100 entries | Regular updates, WWDC announcements |
  358. ## 📦 WWDC Data
  359. All WWDC video data (2014-2025) is **bundled directly in the npm package**, providing:
  360. - ✅ **Zero network latency** - No API calls needed for WWDC content
  361. - ✅ **100% offline access** - Works without internet connection
  362. - ✅ **No rate limits** - Unlimited WWDC searches and browsing
  363. - ✅ **Instant responses** - All data is locally available
  364. The package includes:
  365. - 📹 **1,260+ WWDC session videos** with full transcripts
  366. - 🏷️ **20 topic categories** for organized browsing
  367. - 📅 **13 years of content** (2012-2025)
  368. - 💾 **35MB of optimized JSON data**
  369. > **Note**: Keep your package updated to get the latest WWDC content additions.
  370. ## ⚙️ Configuration
  371. ### 🔄 UserAgent Pool Configuration
  372. The MCP server includes an intelligent UserAgent rotation system to improve API reliability:
  373. #### Environment Variables
  374. | Variable | Description | Default | Example |
  375. |----------|-------------|---------|---------|
  376. | `USER_AGENT_ROTATION_ENABLED` | Enable/disable rotation | `true` | `true` |
  377. | `USER_AGENT_POOL_STRATEGY` | Rotation strategy | `random` | `smart` |
  378. | `USER_AGENT_MAX_RETRIES` | Max retry attempts | `3` | `5` |
  379. | `USER_AGENT_POOL_CONFIG` | Custom pool config (JSON) | Built-in agents | See below |
  380. #### Custom Pool Configuration
  381. ```bash
  382. # Configure custom UserAgent pool
  383. export USER_AGENT_POOL_CONFIG='[
  384. {"userAgent": "MyApp/1.0 (compatible)", "weight": 3, "maxUsageCount": 1000},
  385. {"userAgent": "MyApp/2.0 (advanced)", "weight": 2, "maxUsageCount": 800}
  386. ]'
  387. # Set rotation strategy (random/sequential/smart)
  388. export USER_AGENT_POOL_STRATEGY=smart
  389. # Enable debugging
  390. export NODE_ENV=development
  391. ```
  392. #### Available Strategies
  393. - **`random`**: Fast random selection (best performance)
  394. - **`sequential`**: Round-robin rotation (predictable order)
  395. - **`smart`**: Success rate optimization (best reliability)
  396. #### Built-in UserAgents
  397. The server includes 12+ pre-configured UserAgent strings covering:
  398. - Chrome (Mac Intel/Apple Silicon, Windows, Linux)
  399. - Firefox (Mac Intel/Apple Silicon, Windows, Linux)
  400. - Safari (Mac Intel/Apple Silicon, latest versions)
  401. - Edge (Windows, Mac Intel/Apple Silicon)
  402. ## 🧪 Development
  403. ### Quick Commands
  404. ```bash
  405. # Development with auto-reload
  406. pnpm run dev # or: npm run dev
  407. # Build for production
  408. pnpm run build # or: npm run build
  409. # Type checking
  410. pnpm exec tsc --noEmit # or: npx tsc --noEmit
  411. # Clean build artifacts
  412. pnpm run clean # or: npm run clean
  413. ```
  414. ### Testing Locally
  415. ```bash
  416. # Test the MCP server directly
  417. node dist/index.js
  418. # Test with sample queries
  419. npx @kimsungwhee/apple-docs-mcp --test
  420. ```
  421. ## 🤝 Contributing
  422. Contributions are welcome! Here's how to get started:
  423. 1. **Fork** the repository
  424. 2. **Create** a feature branch: `git checkout -b feature/amazing-feature`
  425. 3. **Commit** your changes: `git commit -m 'Add amazing feature'`
  426. 4. **Push** to the branch: `git push origin feature/amazing-feature`
  427. 5. **Open** a Pull Request
  428. ## 📄 License
  429. MIT License - see [LICENSE](LICENSE) for details.
  430. ## ⚠️ Disclaimer
  431. This project is not affiliated with or endorsed by Apple Inc. It uses publicly available Apple Developer Documentation APIs for educational and development purposes.
  432. ---
  433. <div align="center">
  434. **Made with ❤️ for the Apple Developer Community**
  435. Search Apple Developer Documentation | iOS Development | macOS Development | Swift Programming | SwiftUI | UIKit | Xcode | WWDC Videos | Model Context Protocol | MCP Server
  436. [Report Issues](https://github.com/kimsungwhee/apple-docs-mcp/issues) • [Request Features](https://github.com/kimsungwhee/apple-docs-mcp/issues/new) • [Documentation](https://github.com/kimsungwhee/apple-docs-mcp)
  437. </div>

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.