
sosumi
Fetches Apple documentation as Markdown via Sosumi. Use for Apple API reference, Human Interface Guidelines, WWDC transcripts, and external Swift-DocC pages.
- Installs
- 2K
- Last 24h
- +22
- Trending rank
- #5316
- Security
- Not audited
Install
Works with every agent the skills CLI supports.
npx skills add https://github.com/nshipster/sosumi.ai --skill sosumi- 01
Install
Run the command in your project. The CLI asks which agents to install for.
- 02
Describe the task
Ask your agent for something this skill covers. It loads sosumi automatically when relevant.
- 03
Review the result
The agent follows the SKILL.md steps, scripts and references bundled with the skill.
SKILL.md
The instructions your agent reads when the skill is triggered.
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.
- Don't rely on conformance conditions, such as "Conforms when
Elementconforms toHashable." Apple's documentation data leaves some out and gets some wrong. When a condition matters, read the declaration in the module's.swiftinterfacefile 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.txtorX-Robots-Tagdirectives. - Try another canonical page URL for the same symbol.
FAQ
What does the sosumi skill do?
Fetches Apple documentation as Markdown via Sosumi. Use for Apple API reference, Human Interface Guidelines, WWDC transcripts, and external Swift-DocC pages.
How do I install sosumi?
Run npx skills add https://github.com/nshipster/sosumi.ai --skill sosumi in your project. The skills CLI detects the agents you use and copies the skill into the right folder. For Claude Code you can also place the skill folder at ~/.claude/skills/sosumi/ (personal) or .claude/skills/sosumi/ (project).
Which AI agents can use sosumi?
Any agent that supports the open Agent Skills format (a folder with a SKILL.md file), including Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf, Cline, OpenCode and more.
Is sosumi safe to install?
No partner security audit is available yet. Skills can run commands and scripts, so read the SKILL.md and any bundled files before installing.
Who maintains sosumi?
It is published by nshipster in nshipster/sosumi.ai. It has 2,033 recorded installs.
Popular docs & writing skills
grill-with-docs
mattpocock/skills
A relentless interview to sharpen a plan or design, which also creates docs (ADR's and glossary) as we go.
lark-markdown
open.feishu.cn
飞书 Markdown:查看、创建、上传、编辑和比较飞书中的原生 Markdown 文件。当用户要操作飞书 Markdown 文件,或比较其远端版本及本地草稿时使用。纯本地 Markdown 文件操作不触发本 skill。不负责将 Markdown 导入为飞书在线文档,也不负责文件搜索、权限、评论、移动、删除等云空间管理操作。
writing-beats
mattpocock/skills
Writing, exploit; assemble raw material into a journey of beats, grounding each term before a beat leans on it.
writing-shape
mattpocock/skills
Writing, exploit: shape raw material into an article, paragraph by paragraph.
writing-fragments
mattpocock/skills
Writing, explore: mine raw fragments, no structure yet.
writing-for-agents
mattpocock/skills
Writing documents for agents. Use when creating or editing skills, or modifying AGENTS.md or CLAUDE.md.