mcpField
S
sosumi

sosumi

github.com/nshipster開発4802.1k 回インストール1 週間前に更新
リポジトリ

sosumi について

sosumiは、Apple APIやデザイン、WWDCの情報を必要とするコーディングエージェント向けのスキルです。検索と取得の手順により、外部のSwift-DocCを含む文書をMarkdownで取得します。

主な機能

  1. 01Appleドキュメントの検索
  2. 02APIページのMarkdown取得
  3. 03HIGコンテンツの取得
  4. 04WWDC字幕の取得
  5. 05外部Swift-DocCの取得

活用シーン

  1. 01Swift APIのシグネチャと利用可否の確認
  2. 02ヒューマンインターフェイスガイドラインへの回答
  3. 03WWDCセッション字幕の検索

MCP 対応

https://sosumi.ai/mcpでMCPサーバーとして設定すると、Appleドキュメント、HIGページ、動画字幕、外部Swift-DocCの検索・取得ツールを公開します。

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/nshipster/sosumi.ai --skill sosumi

インストール後、Claude Code で/sosumiを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

_headers
favicon.svg
index.html
llms.txt
robots.txt
sitemap.xml
sosumi.m4a
webmcp.js
icons/
square.and.pencil.svg

詳細

Sosumi スキル

コーディングエージェントが正確な API の詳細を必要とするときに、Apple のドキュメントを Markdown として確実に取得するには、このスキルを使用してください。

使用する場面

以下のいずれかがリクエストに含まれる場合は、Sosumi を使用してください。

  • Apple プラットフォームの API(Swift、SwiftUI、UIKit、AppKit、Foundation など)
  • API シグネチャ、利用可能なプラットフォーム、パラメーターの動作、戻り値の仕様
  • Human Interface Guidelines に関する質問
  • WWDC セッションのトランスクリプト検索
  • 外部の Swift-DocC ドキュメント(GitHub Pages や Swift Package Index のホストなど)

基本的なワークフロー

  1. すでに developer.apple.com の URL がある場合は、ホストを sosumi.ai に置き換え、同じパスを維持してください。
  2. 正確なページパスがわからない場合は、まず検索してから最適な結果を取得してください。
  3. 実装に関する質問に回答する際は、広範なトップレベルページよりも、特定のシンボルのページを優先してください。
CLI による任意の事前確認

Sosumi CLI を利用できる場合は、詳細なデバッグを行う前に、ローカルからアクセスできることを手早く確認してください。

  • sosumi --version で、CLI がインストールされ、PATH に含まれていることを確認できます。
  • sosumi --help で、トップレベルの使い方を確認できます。
  • sosumi <command> --help で、コマンド固有の動作に関するマニュアルを確認できます。

HTTP の使用方法

developer.apple.com を sosumi.ai に置き換えます。

  • 元の URL: https://developer.apple.com/documentation/swift/array
  • AI が読み取り可能な URL: https://sosumi.ai/documentation/swift/array

コンテンツの種類

Apple API リファレンス
  • パターン: https://sosumi.ai/documentation/{framework}/{symbol}
  • 例:
    • https://sosumi.ai/documentation/swift/array
    • https://sosumi.ai/documentation/swiftui/view
Human Interface Guidelines
  • パターン: 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 のビデオトランスクリプト
  • パターン: https://sosumi.ai/videos/play/{collection}/{id}
  • 例:
    • https://sosumi.ai/videos/play/wwdc2021/10133
    • https://sosumi.ai/videos/play/meet-with-apple/208
外部の Swift-DocC
  • パターン: 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 ツールのクイックリファレンス

Sosumi が MCP サーバー(https://sosumi.ai/mcp)として設定されている場合は、以下を使用してください。

ツールパラメーター用途
searchAppleDocumentationquery: stringApple のドキュメントを検索し、構造化された結果を返します
fetchAppleDocumentationpath: stringパスを指定して Apple のドキュメントまたは HIG のコンテンツを Markdown として取得します
fetchAppleVideoTranscriptpath: string/videos/play/... パスを指定して Apple のビデオトランスクリプトを取得します
fetchExternalDocumentationurl: string絶対 HTTPS URL を指定して外部の Swift-DocC ページを取得します

ベストプラクティス

  • 正確なパスがわからない場合は、まず検索してください。
  • コーディングに関する質問では、対象を絞ったシンボルのページを取得してください。
  • ユーザーが詳細をすばやく確認できるよう、回答に出典リンクを含めてください。
  • Apple のドキュメントページを参照する場合は、回答内で Sosumi のパスを直接使用してください。
  • 「Element が Hashable に準拠する場合に準拠する」のような準拠条件を鵜呑みにしないでください。Apple のドキュメントデータには、一部の条件が記載されていなかったり、誤っていたりします。条件が重要な場合は、SDK のモジュールにある .swiftinterface ファイルで宣言を確認してください。

トラブルシューティング

404 または出力が少ない場合
  • パスが間違っているか、対象が広すぎる可能性があります。
  • まず検索クエリを実行し、特定の結果のパスを取得してください。
外部ページを取得できない場合
  • ホストが robots.txt または X-Robots-Tag ディレクティブによってアクセスをブロックしている可能性があります。
  • 同じシンボルの別の正規ページ URL を試してください。

コメント