Sosumi

NSHipster/sosumi.ai/plugin/skills/sosumi

作者 NSHipster80f5c0f38bab643605f247c0d362913e5c2fde3c无许可证483 个星标收录于 2026年11月7日更新于 2026年11月7日仓库今天更新

Fetches Apple documentation as Markdown via Sosumi. Use for Apple API reference, Human Interface Guidelines, WWDC transcripts, and external Swift-DocC pages.

AI 生成的概览

通过 Sosumi 以 Markdown 形式获取 Apple 开发文档,涵盖 API 参考、HIG、WWDC 文字稿和 Swift-DocC 页面。

功能
说明如何以 Markdown 形式获取 Apple 文档:将 developer.apple.com 链接的主机替换为 sosumi.ai,或使用 Sosumi MCP 工具进行搜索、抓取文档、获取视频文字稿和外部 Swift-DocC 页面。文档列出了 API 参考、人机界面指南、WWDC/Apple 视频文字稿及外部 Swift-DocC 站点的 URL 模式,并给出最佳实践以及 404 或主机被拦截时的排查方法。产出为抓取到的文档内容及引用来源链接的建议。
适用场景
当请求涉及 Swift、SwiftUI、UIKit、Foundation 等 Apple 平台 API,需要 API 签名、可用性或参数行为,询问人机界面指南,查找 WWDC 会议文字稿,或需要外部 Swift-DocC 文档时使用。
运行要求
需要能访问 sosumi.ai 的网络(HTTP 抓取),或已配置 sosumi.ai/mcp 的 Sosumi MCP 服务器;Sosumi CLI 为可选的预检工具。不包含脚本。

Sosumi Skill

Use this skill to reliably fetch Apple docs as Markdown when coding agents need precise API details.

When to Use

Use Sosumi when the request involves any of the following:

  • Apple platform APIs (Swift, SwiftUI, UIKit, AppKit, Foundation, etc.)
  • API signatures, availability, parameter behavior, or return semantics
  • Human Interface Guidelines questions
  • WWDC session transcript lookup
  • External Swift-DocC documentation (for example, GitHub Pages or Swift Package Index hosts)

Core Workflow

  1. If you already have a developer.apple.com URL, replace the host with sosumi.ai and keep the same path.
  2. If you do not know the exact page path, search first, then fetch the best match.
  3. Prefer specific symbol pages instead of broad top-level pages when answering implementation questions.

Optional CLI Preflight

If the Sosumi CLI is available, quickly verify local access before deeper debugging:

  • sosumi --version confirms the CLI is installed and on PATH.
  • sosumi --help shows top-level usage.
  • sosumi <command> --help is the manual for command-specific behavior.

HTTP Usage

Replace developer.apple.com with sosumi.ai:

  • Original: https://developer.apple.com/documentation/swift/array
  • AI-readable: https://sosumi.ai/documentation/swift/array

Content Types

Apple API Reference

  • Pattern: https://sosumi.ai/documentation/{framework}/{symbol}
  • Examples:
    • https://sosumi.ai/documentation/swift/array
    • https://sosumi.ai/documentation/swiftui/view

Human Interface Guidelines

  • Pattern: https://sosumi.ai/design/human-interface-guidelines/{topic}
  • Examples:
    • https://sosumi.ai/design/human-interface-guidelines
    • https://sosumi.ai/design/human-interface-guidelines/foundations/color

Apple Video Transcripts

  • Pattern: https://sosumi.ai/videos/play/{collection}/{id}
  • Examples:
    • https://sosumi.ai/videos/play/wwdc2021/10133
    • https://sosumi.ai/videos/play/meet-with-apple/208

External Swift-DocC

  • Pattern: https://sosumi.ai/external/{full-https-url}
  • Examples:
    • https://sosumi.ai/external/https://swiftlang.github.io/swift-docc-plugin/documentation/swiftdoccplugin/
    • https://sosumi.ai/external/https://swiftpackageindex.com/pointfreeco/swift-composable-architecture/1.23.1/documentation/composablearchitecture

MCP Tools Quick Reference

Use these when Sosumi is configured as an MCP server (https://sosumi.ai/mcp):

ToolParametersUse
searchAppleDocumentationquery: stringSearch Apple documentation and return structured results
fetchAppleDocumentationpath: stringFetch Apple docs or HIG content by path as Markdown
fetchAppleVideoTranscriptpath: stringFetch Apple video transcript by /videos/play/... path
fetchExternalDocumentationurl: stringFetch external Swift-DocC page by absolute HTTPS URL

Best Practices

  • Search first if the exact path is unknown.
  • Fetch targeted symbol pages for coding questions.
  • Keep source links in answers so users can verify details quickly.
  • Use Sosumi paths directly in responses whenever referencing Apple documentation pages.
  • Don't rely on conformance conditions, such as "Conforms when Element conforms to Hashable." Apple's documentation data leaves some out and gets some wrong. When a condition matters, read the declaration in the module's .swiftinterface file in the SDK.

Troubleshooting

404 or sparse output

  • The path may be incorrect or too broad.
  • Run a search query first, then fetch a specific result path.

External page cannot be fetched

  • The host may block access via robots.txt or X-Robots-Tag directives.
  • Try another canonical page URL for the same symbol.

来源与署名

来源:NSHipster/sosumi.ai位于plugin/skills/sosumi提交80f5c0f

许可证: 无许可证

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

在 README 中添加徽章

向读者展示该技能已收录于 SourceWeft,徽章链接到本页。

“Listed on SourceWeft”徽章预览
[![Listed on SourceWeft](https://sourceweft.com/badge/skills/gh-nshipster-sosumi-ai-sosumi-plugin-skills-sosumi-b6484cb8358c6954.svg)](https://sourceweft.com/skills/gh-nshipster-sosumi-ai-sosumi-plugin-skills-sosumi-b6484cb8358c6954?utm_source=readme&utm_medium=badge)

举报或申请下架