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)

檢舉或申請下架