Sosumi

NSHipster/sosumi.ai/plugin/skills/sosumi

by NSHipster80f5c0f38bab643605f247c0d362913e5c2fde3cNo license483 starsListed Nov 7, 2026Updated Nov 7, 2026Repository updated today

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

AI-generated overview

Fetches Apple developer documentation as Markdown via Sosumi for API references, HIG pages, WWDC transcripts and Swift-DocC sites.

What it does
Explains how to retrieve Apple documentation in Markdown form by rewriting developer.apple.com URLs to the sosumi.ai host, or by using Sosumi MCP tools for search, doc fetch, video transcripts and external Swift-DocC pages. It lists URL patterns for API reference, Human Interface Guidelines, WWDC/Apple video transcripts and external Swift-DocC sites, plus best practices and troubleshooting for 404s or blocked hosts. It produces fetched documentation content and guidance on citing source links.
When to use it
Use when a request involves Apple platform APIs such as Swift, SwiftUI, UIKit or Foundation, needs API signatures, availability or parameter behavior, asks about Human Interface Guidelines, looks up WWDC session transcripts, or needs external Swift-DocC documentation.
Requirements
Network access to sosumi.ai (HTTP fetches) or a configured Sosumi MCP server at sosumi.ai/mcp; the Sosumi CLI is optional for preflight checks. No scripts are included.

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.

Source and attribution

Source:NSHipster/sosumi.aiinplugin/skills/sosumiat commit80f5c0f

License: No license

Content belongs to its original authors. SourceWeft indexes it from a public repository.

Add a badge to your README

Show readers this skill is listed on SourceWeft. The badge links to this page.

Preview of the “Listed on SourceWeft” badge
[![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)

Report or request removal