NSHipster/sosumi.ai

Making Apple docs AI-readable

sosumi.ai – AIが読み取り可能な Apple Developer ドキュメント

何であるか : Cloudflare Workers 上でホストされている小さなウェブサービス。JavaScript でレンダリングされる Apple Developer ドキュメントページ(Swift ドキュメント、HIG、WWDC 話題のトランスクリプトなど)を、AI モデルや自動化ツールが簡単に扱えるように、クリーンな Markdown に変換します。出力は、言語モデルやその他の自動化ツールにとって扱いやすい形式です。

動作方法 :

  • サービスは、Apple ドキュメント URL のホスト部分(developer.apple.com または Swift-DocC サイト)を sosumi.ai にリライトします。
  • 基盤となる DocC JSON エンドポイントを解決し、コンテンツを抽出して Markdown(またはスクリプト用の JSON ラッピングされた Markdown)として返します。
  • 外部の Swift-DocC サイトに対しても同様にプロキシ処理が可能で、robots.txt を尊重し、カスタム sosumi-ai ユーザーエージェントを使用します。

主な利用方法

  1. HTTP API – 任意の Apple ドキュメントまたは WWDC 動画 URL のホストを置き換えるだけです。
    https://developer.apple.com/documentation/swift/array
    → https://sosumi.ai/documentation/swift/array
    
    同じパターンは、Human Interface Guidelines および WWDC 話題のトランスクリプト URL にも適用可能です。
  2. MCP(Message Control Protocol)統合 – HTTP、Server-Sent Events、またはシンプルな stdio プロキシ(npx mcp-remote …)で利用可能なストリーミング対応エンドポイント(/mcp)。
  3. CLInpx @nshipster/sosumi fetch <url>(またはグローバルインストールで sosumi)。ドキュメント、HIG ページ、動画トランスクリプト、外部 Swift-DocC サイトの取得、Apple ドキュメントインデックスの検索をサポート。--json オプションで JSON 出力が可能。
  4. Chrome 拡張機能 – Apple ドキュメントページに「Copy sosumi Link」ボタンを追加(コミュニティメンテナンス)。
  5. AIエージェント用スキルファイルhttps://sosumi.ai/SKILL.md にある Markdown 形式のスキル定義。npx skills add https://sosumi.ai で、仕様準拠のエージェントに追加可能。

組み込みの主要ツール(MCP を通じて公開)

  • searchAppleDocumentation – テキスト全体検索。タイトル、URL、パンくずリストなどを返す。
  • fetchAppleDocumentation – ドキュメントページを Markdown として取得。
  • fetchAppleVideoTranscript – WWDC セッションのトランスクリプトを取得。
  • fetchExternalDocumentation – 任意の公開 Swift-DocC ページを取得(ホストの許可/ブロックリストに従う)。

セルフホスティング

  • Node 20+Hono フレームワークで記述されており、Cloudflare Workers、Vercel、Netlify、または Hono 対応の任意のプラットフォームで実行可能。
  • クローン後、npm install して npm run dev を実行するとローカル開発サーバーが起動(デフォルト http://localhost:8787)。
  • 本番デプロイでは Cloudflare Workers(wrangler)を使用。ホストが検証を要求する場合、オプションの Ed25519 Web Bot 認証署名が利用可能。鍵は WEB_BOT_AUTH_KEY シークレットで提供。
  • 外部ホストアクセスは EXTERNAL_DOC_HOST_ALLOWLIST / EXTERNAL_DOC_HOST_BLOCKLIST 環境変数で制限可能。

開発と品質

  • テストは vitest で実行(npm run test)。
  • 形式・Lint は Biome で実行(npm run check)。
  • CI/CD でタグ付きリリースを npm および GitHub リリースに自動公開。

法的注意事項

  • 非公式。Apple とは関係ありません。オンデマンドでページを取得し、robots ディレクティブを尊重し、永続的なコピーは保存しません。

クイックスタート

# クローンしてローカルで実行
git clone https://github.com/nshipster/sosumi.ai.git
cd sosumi.ai
npm install
npm run dev   # http://localhost:8787 が開く

# CLI を使用
npx @nshipster/sosumi fetch https://developer.apple.com/documentation/swift/array

便利なリンク

関連

  • プロジェクト
  • プロジェクト
  • プロジェクト
  • プロジェクト
  • プロジェクト