mcpField
X
xcdocs

xcdocs

github.com/bitrigapp开发18239 次安装2 周前更新
代码仓库

关于 xcdocs

xcdocs 是用于代码实现过程的本地 Apple 框架参考工具,适合需要核实 API 文档的开发者。它支持搜索文档条目并查看完整内容,以确认符号、用法和可用性。

主要功能

  1. 01搜索符号、文章与主题
  2. 02按框架和类型筛选
  3. 03查看完整文档条目
  4. 04提供 JSON 输出

适用场景

  1. 01核实导致编译失败的 API 名称
  2. 02了解新发布的框架功能
  3. 03确认 API 条目的类型
  4. 04查找相关类型与概念

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/bitrigapp/xcdocs --skill xcdocs

安装后在 Claude Code 中输入/xcdocs确认已加载。

附带文件agents/openai.yamlreferences/cli.md

详细介绍

XCDocs

在修改代码时,将 xcdocs 用作本地 Apple 框架参考。

在实现过程中使用

  • 在依赖此技能之前,确保 xcdocs 可用。
  • 遇到不熟悉、刚发布、已重命名或导致编译失败的 Apple API 时,使用它查询。
  • 先使用 search --json --omit-content 查找可能相关的符号、文章或主题。
  • 如果查询范围较广,添加可重复使用的 --framework 和 --kind {article|symbol|topic} 筛选条件。
  • 将搜索结果中 documents[].uri 视为 get 的规范标识符。
  • 在编辑依赖该 API 的代码之前,使用 get --json 检查完整条目。
  • 将查到的信息应用到代码中:修正符号名称、选择正确的重载、调整可用性保护条件,或改用文档说明的 API。

常见用途

  • 通过核实实际符号名称和入口点,修复 Apple 框架相关的编译错误。
  • 在将新发布的框架或功能领域接入代码之前,先进行探索。
  • 确认某个 API 是符号、更广泛的主题页面,还是附有设置指南的文章。
  • 找到一个相关文档条目后,查找关联的类型或概念。

参考

评论

支持 Markdown