Apple Docs MCP - Apple 开发者文档模型上下文协议服务器

Apple 开发者文档 MCP 服务器 - 通过模型上下文协议访问 Apple 官方开发文档、框架、API、SwiftUI、UIKit 和 WWDC 视频。使用 AI 自然语言查询搜索 iOS、macOS、watchOS、tvOS 和 visionOS 文档。在 Claude、Cursor 或任何兼容 MCP 的 AI 助手中即时获取 Swift/Objective-C 代码示例、API 参考和技术指南。

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

✨ 功能特性

• 🔍 智能搜索: 智能搜索 SwiftUI、UIKit、Foundation、CoreData、ARKit 等 Apple 开发者文档
• 📚 完整文档访问: 完全访问 Apple JSON API，获取 Swift、Objective-C 和框架文档
• 🔧 框架索引: 浏览 iOS、macOS、watchOS、tvOS、visionOS 框架的分层 API 结构
• 📋 技术目录: 探索包括 SwiftUI、UIKit、Metal、Core ML、Vision 和 ARKit 在内的 Apple 技术
• 📰 文档更新: 跟踪 WWDC 2024/2025 公告、iOS 26、macOS 26 和最新 SDK 发布
• 🎯 技术概览: Swift、SwiftUI、UIKit 和所有 Apple 开发平台的综合指南
• 💻 示例代码库: iOS、macOS 和跨平台开发的 Swift 和 Objective-C 代码示例
• 🎥 WWDC 视频库: 搜索 WWDC 2014-2025 会议，包含文字记录、Swift/SwiftUI 代码示例和资源
• 🔗 相关 API 发现: 查找 SwiftUI 视图、UIKit 控制器和框架特定的 API 关系
• 📊 平台兼容性: iOS 13+、macOS 10.15+、watchOS 6+、tvOS 13+、visionOS 兼容性分析
• ⚡ 高性能: 针对 Xcode、Swift Playgrounds 和 AI 驱动的开发环境进行优化
• 🌐 多平台: 完整的 iOS、iPadOS、macOS、watchOS、tvOS 和 visionOS 文档支持
• 🏷️ Beta 和状态跟踪: iOS 26 beta API、已弃用的 UIKit 方法、新 SwiftUI 功能跟踪

🚀 快速开始

Claude Desktop（推荐）

将此配置添加到您的 Claude Desktop 配置文件中：

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"]
    }
  }
}

注意: 如果遇到使用旧版本的问题，添加 @latest 以强制使用最新版本：

"args": ["-y", "@kimsungwhee/apple-docs-mcp@latest"]

重启 Claude Desktop 并开始询问 Apple API！

📦 安装指南

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

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

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

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

{
  "context_servers": {
    "Apple Docs": {
      "command": {
        "path": "npx",
        "args": ["-y", "@kimsungwhee/apple-docs-mcp"]
      },
      "settings": {}
    }
  }
}

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

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

# 使用 pnpm（推荐）
pnpm add -g @kimsungwhee/apple-docs-mcp

# 使用 npm
npm install -g @kimsungwhee/apple-docs-mcp

npx @kimsungwhee/apple-docs-mcp --help

git clone https://github.com/kimsungwhee/apple-docs-mcp.git
cd apple-docs-mcp

# 使用 pnpm（推荐）
pnpm install && pnpm run build

# 使用 npm
npm install && npm run build

💬 使用示例

🔍 智能搜索

"搜索 SwiftUI 动画"
"查找 withAnimation API 文档"
"查询 Swift 中的 async/await 模式"
"显示 AlarmKit 调度示例"

📚 文档访问

"获取 SwiftUI 框架的详细信息"
"显示 withAnimation API 及相关 API"
"获取 SwiftData 的平台兼容性"
"访问 UIViewController 文档及类似 API"

🔧 框架探索

"显示 SwiftUI 框架 API 索引"
"列出所有 UIKit 类和方法"
"浏览 ARKit 框架结构"
"获取 WeatherKit API 层次结构"

🔗 API 发现

"查找与 UIViewController 相关的 API"
"显示与 withAnimation 类似的 API"
"获取 SwiftData 文档中的所有引用"
"发现 Core Data NSManagedObject 的替代方案"

📋 技术和平台分析

"列出 iOS 26 中的所有 Beta 框架"
"显示图形和游戏技术"
"有哪些机器学习框架可用？"
"分析 Vision 框架的平台兼容性"

📰 文档更新

"显示最新的 WWDC 更新"
"SwiftUI 有什么新功能？"
"获取 iOS 的技术更新"
"显示 Xcode 的发布说明"
"查找最新更新中的 beta 功能"

🎯 技术概览

"显示应用设计和 UI 的技术概览"
"获取游戏开发的综合指南"
"探索 AI 和机器学习概览"
"显示 iOS 特定的技术指南"
"获取数据管理技术概览"

💻 示例代码库

"显示 SwiftUI 示例代码项目"
"查找机器学习示例代码"
"获取 UIKit 示例项目"
"显示精选 WWDC 示例代码"
"查找 Core Data 示例实现"
"仅显示测试版示例代码项目"

🎥 WWDC 视频搜索

"搜索关于 SwiftUI 的 WWDC 视频"
"查找机器学习的 WWDC 会议"
"显示 WWDC 2024 视频"
"搜索 async/await WWDC 演讲"
"查找关于 Swift 并发的 WWDC 视频"
"显示无障碍主题的 WWDC 会议"

📺 WWDC 视频详情

"获取 WWDC 会议 10176 的详情"
"显示 WWDC23 SwiftData 会议的文字记录"
"获取 WWDC 视频 10019 的代码示例"
"显示 Vision Pro WWDC 会议的资源"
"获取 'Meet async/await in Swift' 会议的文字记录"

📋 WWDC 主题和年份

"列出所有 WWDC 主题"
"显示 Swift 主题的 WWDC 视频"
"获取关于开发者工具的 WWDC 视频"
"列出 2023 年的 WWDC 视频"
"显示所有 SwiftUI 和 UI 框架会议"
"获取机器学习 WWDC 内容"

🛠️ 高级用法

"查找 @State 相关 API 及平台分析"
"解析 SwiftUI 文档中的所有引用"
"获取 Vision 框架的平台兼容性分析"
"深度搜索与 UIViewController 类似的 API"

🛠️ 可用工具

🏗️ 技术架构

apple-docs-mcp/
├── 🔧 src/
│   ├── index.ts                      # MCP 服务器入口点，包含所有工具
│   ├── tools/                        # MCP 工具实现
│   │   ├── search-parser.ts          # HTML 搜索结果解析
│   │   ├── doc-fetcher.ts            # JSON API 文档获取
│   │   ├── list-technologies.ts      # 技术目录处理
│   │   ├── get-documentation-updates.ts # 文档更新跟踪
│   │   ├── get-technology-overviews.ts # 技术概览和指南
│   │   ├── get-sample-code.ts        # 示例代码库浏览器
│   │   ├── get-framework-index.ts    # 框架结构索引
│   │   ├── get-related-apis.ts       # 相关 API 发现
│   │   ├── resolve-references-batch.ts # 批量引用解析
│   │   ├── get-platform-compatibility.ts # 平台分析
│   │   ├── find-similar-apis.ts      # 类似 API 推荐
│   │   └── wwdc/                     # WWDC 视频工具
│   │       ├── wwdc-handlers.ts      # WWDC 工具处理程序
│   │       ├── content-extractor.ts  # 视频内容提取
│   │       ├── topics-extractor.ts   # 主题列表
│   │       └── video-list-extractor.ts # 视频列表解析
│   └── utils/                        # 工具函数和辅助程序
│       ├── cache.ts                  # 带 TTL 支持的内存缓存
│       ├── constants.ts              # 应用程序常量和 URL
│       ├── error-handler.ts          # 错误处理和验证
│       ├── http-client.ts            # 带性能跟踪的 HTTP 客户端
│       └── url-converter.ts          # URL 转换工具
├── 📦 dist/                          # 编译后的 JavaScript
├── 📄 package.json                   # 包配置
└── 📖 README.md                      # 此文件

🚀 性能特性

• 基于内存的缓存: 自定义缓存实现，具有自动清理和 TTL 支持
• 智能搜索: 官方 Apple 搜索 API，具有增强的结果格式化
• 增强分析: 可选的相关 API、平台兼容性和相似性分析
• 错误恢复: 优雅降级，全面的错误处理
• 类型安全: 完整的 TypeScript，使用 Zod v4.0.5 进行运行时验证
• 最新依赖: MCP SDK v1.15.1，优化的包占用空间

💾 缓存策略

🧪 开发

常用命令

# 开发模式（自动重载）
pnpm run dev    # 或: npm run dev

# 生产构建
pnpm run build  # 或: npm run build

# 类型检查
pnpm exec tsc --noEmit  # 或: npx tsc --noEmit

# 清理构建产物
pnpm run clean  # 或: npm run clean

本地测试

# 直接测试 MCP 服务器
node dist/index.js

# 使用示例查询测试
npx @kimsungwhee/apple-docs-mcp --test

🤝 贡献

欢迎贡献！以下是开始的方法：

1. Fork 仓库
2. 创建 功能分支: git checkout -b feature/amazing-feature
3. 提交 更改: git commit -m 'Add amazing feature'
4. 推送 到分支: git push origin feature/amazing-feature
5. 打开 Pull Request

📄 许可证

MIT 许可证 - 详见 LICENSE。

⚠️ 免责声明

此项目与 Apple Inc. 无关联或认可。它使用公开可用的 Apple 开发者文档 API 用于教育和开发目的。