Engineering
sosumi avatar

sosumi

Retrieves Apple platform documentation, Human Interface Guidelines, and WWDC transcripts as Markdown using the Sosumi service.

Introduction

The Sosumi skill is a specialized utility designed for developers building on Apple platforms. It acts as an interface to the Sosumi API, which transforms official Apple documentation—including API references for Swift, SwiftUI, UIKit, AppKit, and Foundation—into structured, agent-readable Markdown. By bridging the gap between raw web documentation and AI processing, this tool ensures that agents have access to precise, context-aware information regarding API signatures, parameter behaviors, return types, and platform availability, thereby minimizing hallucinations in complex code generation tasks.

  • Provides direct access to comprehensive Apple API references, enabling accurate coding assistant responses.

  • Supports Human Interface Guidelines (HIG) lookup to help designers and developers align with Apple's design principles.

  • Enables retrieval of WWDC session transcripts, allowing for rapid synthesis of technical insights from Apple's annual conferences.

  • Facilitates the fetching of external Swift-DocC documentation hosted on GitHub Pages, Swift Package Index, or other community platforms.

  • Implements a standardized request pattern by replacing hostnames to redirect developer.apple.com traffic to the Sosumi.ai endpoint.

  • Users should prioritize searching first if the exact documentation path is unknown to ensure the highest result accuracy.

  • When querying, request specific symbol pages rather than broad top-level documentation to receive the most targeted technical details.

  • The output is formatted as clean Markdown, making it ideal for integration into development workflows, pull request reviews, and debugging sessions.

  • Keep track of source links provided in the output to verify information against the official Apple Developer portal when necessary.

  • Note that some external documentation sites may restrict automated access via robots.txt or X-Robots-Tag; in such cases, attempt to locate an alternative canonical page for the same symbol.

Repository Stats

Stars
0
Forks
0
Open Issues
0
Language
Shell
Default Branch
main
Sync Status
Idle
Last Synced
May 3, 2026, 08:20 PM
View on GitHub