Back to Details

sosumi

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Sosumi Skill

Sosumi技能

Use this skill to reliably fetch Apple docs as Markdown when coding agents need precise API details.
当编码Agent需要精确的API详情时，可使用该技能可靠地将Apple文档抓取为Markdown格式。

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)
当请求涉及以下任意内容时可使用Sosumi：
  • Apple平台API（
    Swift
    、
    SwiftUI
    、
    UIKit
    、
    AppKit
    、
    Foundation
    等）
  • API签名、可用性、参数行为或返回语义
  • 人机界面指南相关问题
  • WWDC会议文字记录查询
  • 外部Swift-DocC文档（例如GitHub Pages或Swift Package Index托管的文档）

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.
  1. 如果你已经有
    developer.apple.com
    的URL，将域名替换为
    sosumi.ai
    ，保留原有路径即可。
  2. 如果你不知道确切的页面路径，先进行搜索，再抓取匹配度最高的页面。
  3. 回答实现相关问题时，优先选择具体的符号页面，而非宽泛的顶层页面。

HTTP Usage

HTTP使用方式

Replace 
developer.apple.com
with 
sosumi.ai
:
  • Original: 
    https://developer.apple.com/documentation/swift/array
  • AI-readable: 
    https://sosumi.ai/documentation/swift/array
将
developer.apple.com
替换为
sosumi.ai
：
  • 原链接：
    https://developer.apple.com/documentation/swift/array
  • AI可读取链接：
    https://sosumi.ai/documentation/swift/array

Content Types

内容类型

Apple API Reference

Apple API参考

  • Pattern: 
    https://sosumi.ai/documentation/{framework}/{symbol}
  • Examples: 
    • https://sosumi.ai/documentation/swift/array
    • https://sosumi.ai/documentation/swiftui/view
  • 格式：
    https://sosumi.ai/documentation/{framework}/{symbol}
  • 示例： 
    • 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
  • 格式：
    https://sosumi.ai/design/human-interface-guidelines/{topic}
  • 示例： 
    • https://sosumi.ai/design/human-interface-guidelines
    • https://sosumi.ai/design/human-interface-guidelines/foundations/color

Apple Video Transcripts

Apple视频文字记录

  • 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
  • 格式：
    https://sosumi.ai/videos/play/{collection}/{id}
  • 示例： 
    • https://sosumi.ai/videos/play/wwdc2021/10133
    • https://sosumi.ai/videos/play/meet-with-apple/208

External Swift-DocC

外部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
  • 格式：
    https://sosumi.ai/external/{full-https-url}
  • 示例： 
    • 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

MCP工具快速参考

Use these when Sosumi is configured as an MCP server (
https://sosumi.ai/mcp
):
ToolParametersUse
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
当Sosumi被配置为MCP服务器（
https://sosumi.ai/mcp
）时可使用以下工具：
工具参数用途
searchAppleDocumentation
query: string
搜索Apple文档并返回结构化结果
fetchAppleDocumentation
path: string
按路径抓取Apple文档或HIG内容，返回Markdown格式
fetchAppleVideoTranscript
path: string
按
/videos/play/...
路径抓取Apple视频文字记录
fetchExternalDocumentation
url: string
按绝对HTTPS URL抓取外部Swift-DocC页面

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.
  • 如果不知道确切路径，请先搜索。
  • 编码相关问题优先抓取针对性的符号页面。
  • 在回答中保留源链接，方便用户快速验证详情。
  • 引用Apple文档页面时，尽可能直接使用Sosumi路径。

Troubleshooting

故障排查

404 or sparse output

404或输出内容稀疏

  • 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.
  • 托管站点可能通过
    robots.txt
    或
    X-Robots-Tag
    指令禁止了访问。
  • 尝试该符号对应的其他规范页面URL。