sosumi
nshipster/sosumi.ai
Fetch Apple documentation as Markdown—API reference, HIG, WWDC transcripts, and Swift-DocC pages.
What is sosumi?
Sosumi reliably converts Apple developer documentation into AI-readable Markdown format. Use it when you need precise API details, Human Interface Guidelines, WWDC session transcripts, or external Swift-DocC pages during coding tasks.
- Converts Apple API reference pages (Swift, SwiftUI, UIKit, AppKit, Foundation) to Markdown
- Fetches Human Interface Guidelines content by topic
- Retrieves WWDC session transcripts and Apple video transcripts
- Accesses external Swift-DocC documentation from GitHub Pages and Swift Package Index
- Provides structured search results across Apple documentation
How to install sosumi
npx skills add https://github.com/nshipster/sosumi.ai --skill sosumiHow to use sosumi
- 1.If you have a developer.apple.com URL, replace the host with sosumi.ai and keep the same path
- 2.If you don't know the exact path, use the search tool first to find the best match
- 3.For API questions, fetch specific symbol pages rather than broad top-level pages
- 4.For external Swift-DocC, provide the full HTTPS URL to the documentation page
- 5.Include the Sosumi path in your response so users can verify details
Use cases
- Looking up exact API signatures and parameter behavior for Swift standard library or framework classes
- Finding Human Interface Guidelines for specific design topics during app development
- Retrieving WWDC session transcripts to understand implementation patterns
- Accessing Swift-DocC pages for third-party packages hosted on GitHub or Swift Package Index
- Verifying availability and return semantics for platform APIs
- Swift and iOS/macOS developers
- AI coding agents (Claude Code, Cursor) working on Apple platform projects
- Developers building SwiftUI or UIKit applications
- Anyone needing precise, up-to-date Apple documentation in machine-readable format
sosumi FAQ
The path may be incorrect or too broad. Run a search query first, then fetch a specific result path.
Yes, via the external Swift-DocC pattern. Provide the full HTTPS URL to the documentation page (e.g., from GitHub Pages or Swift Package Index).
Use the searchAppleDocumentation tool with your query term. It returns structured results you can then fetch with the specific path.
The host may block access via robots.txt or X-Robots-Tag directives. Try another canonical URL for the same symbol.
Full instructions (SKILL.md)
Source of truth, from nshipster/sosumi.ai.
name: sosumi description: Fetches Apple documentation as Markdown via Sosumi. Use for Apple API reference, Human Interface Guidelines, WWDC transcripts, and external Swift-DocC pages.
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
- If you already have a
developer.apple.comURL, replace the host withsosumi.aiand keep the same path. - If you do not know the exact page path, search first, then fetch the best match.
- 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 --versionconfirms the CLI is installed and onPATH.sosumi --helpshows top-level usage.sosumi <command> --helpis 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/arrayhttps://sosumi.ai/documentation/swiftui/view
Human Interface Guidelines
- Pattern:
https://sosumi.ai/design/human-interface-guidelines/{topic} - Examples:
https://sosumi.ai/design/human-interface-guidelineshttps://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/10133https://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://apple.github.io/swift-argument-parser/documentation/argumentparser/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):
| Tool | Parameters | Use |
|---|---|---|
searchAppleDocumentation | query: string | Search Apple documentation and return structured results |
fetchAppleDocumentation | path: string | Fetch Apple docs or HIG content by path as Markdown |
fetchAppleVideoTranscript | path: string | Fetch Apple video transcript by /videos/play/... path |
fetchExternalDocumentation | url: string | Fetch 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.
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.txtorX-Robots-Tagdirectives. - Try another canonical page URL for the same symbol.
Related skills
More from nshipster/sosumi.ai and the wider catalog.

hallmark
Anti-AI-slop design skill for building, auditing, and redesigning UIs with structural variety.
nuxt-ui
125+ accessible Vue components with Tailwind CSS theming for Nuxt, Vue, Laravel, and AdonisJS.

accelerated-computing-cudf
Official NVIDIA cuDF guidance for GPU-accelerated pandas DataFrames, ETL, and multi-GPU workloads.

aiq-deploy
Deploy and validate NVIDIA AI-Q Blueprint infrastructure locally or on Kubernetes.

aiq-research
Run deep research queries against a local NVIDIA AI-Q Blueprint backend.

cudaq-guide
Setup CUDA-Q, choose simulation targets, access QPUs, and author @cudaq.kernel code.