Apple Doc MCP

用Rust编写的模型上下文协议（MCP）服务器，可直接在您的AI编码助手中无缝访问Apple的开发者文档。

快速开始

"Use apple mcp select swiftui search tabbar"

配置您的MCP客户端（示例）：

构建Rust二进制文件（需要Rust 1.76+）：

cargo build --release

然后让您的MCP客户端指向已编译的CLI：

{
  "mcpServers": {
    "apple-docs": {
      "command": "/absolute/path/to/apple-doc-mcp-main/target/release/apple-docs-cli"
    }
  }
}

对于本地开发，您可以直接运行服务器：

cargo run -p apple-docs-cli

CLI 使用

CLI现在提供了专用子命令，因此您可以在不先连接MCP客户端的情况下脚本化文档查询：

# 运行JSON-RPC传输（现有MCP集成）
apple-docs serve

# 使用结构化表格输出检查可用工具（默认格式=markdown）
apple-docs tools list --format table

# 直接从shell执行工具
apple-docs tools call search_symbols \
  --arguments '{"query": "tab view layout"}' --format json

# 利用参数文件处理更复杂的负载
apple-docs tools call get_documentation --arguments @payload.json

# 监控最近的工具活动
apple-docs telemetry --limit 10 --format table

# 审查并预热磁盘缓存以离线使用
apple-docs cache status
apple-docs cache warmup --frameworks SwiftUI --frameworks UIKit --refresh
apple-docs cache clear-memory

全局标志有助于调整可访问性和自动化：

• --format json|markdown|table|text 在渲染样式之间切换。
• --quiet 抑制面向人类的消息，适用于脚本。
• --no-color 和 --no-progress 禁用ANSI样式和进度条。
• --cache-dir <path> 覆盖 APPLEDOC_CACHE_DIR 用于临时工作空间。

长时间运行的操作（框架预热、远程工具调用）会显示进度条，并在完成后自动折叠成简洁的状态行。

🔄 典型工作流程

1. 探索目录：
   • discover_technologies { "query": "swift" }
   • discover_technologies { "page": 2, "pageSize": 10 }
2. 锁定一个框架：
   • choose_technology "SwiftUI"
   • current_technology
3. 在当前框架内搜索：
   • search_symbols { "query": "tab view layout" }
   • search_symbols { "query": "toolbar", "maxResults": 5 }
4. 打开文档：
   • get_documentation { "path": "TabView" }
   • get_documentation { "path": "documentation/SwiftUI/TabViewStyle" }
5. 请求指导性食谱：
   • how_do_i { "task": "add search suggestions" }
   • how_do_i { "task": "limit search with scopes" }

搜索技巧

• 从广泛开始（例如 "tab"，"animation"，"gesture"）。
• 尝试同义词（"sheet" 对比 "modal"，"toolbar" 对比 "tabbar"）。
• 使用多个关键词（"tab view layout"）以缩小结果。
• 如果没有找到结果，请使用不同的关键词重新运行 discover_technologies 或选择另一个框架。

增强输出

• 快速摘要现在包括内联Swift代码片段（如果可用）、平台可用性、精选下一步操作以及布局、排版、颜色和可访问性的Human Interface Guideline（HIG）亮点。
• 搜索结果展示可用性徽章、SwiftUI ↔ UIKit/AppKit桥接提示、HIG“设计检查表”项目符号以及从知识库中提取的相关符号。
• 文档中的 Integration Notes 提供迁移提示、UIKit/AppKit对应项以及您应探索的下一个相关API；新的 设计指南 部分直接链接到相关的HIG文章。
• current_technology 展示所选框架的HIG入门指南，以便您可以直接跳入最佳设计实践，而 discover_technologies 标记具有内置设计指导的框架。

🧰 可用工具

• discover_technologies – 浏览/筛选框架之前选择一个。
• choose_technology – 设置活动框架；在搜索文档之前需要设置。
• current_technology – 显示当前选择和快速下一步操作。
• search_symbols – 在活动框架内进行模糊关键字搜索。
• get_documentation – 查看符号文档（允许相对名称）。
• how_do_i – 获取常见SwiftUI任务的指导性多步骤食谱。