mcpField
S
salla-docs

salla-docs

github.com/sallaapp開発297 回インストール今日更新
リポジトリ

salla-docs について

Salla 開発者向けに、テーマ別のリファレンスページを探し、掲載された OpenAPI 契約を読むためのスキルです。最新仕様による検証、更新候補の確認、リンク切れ時のページ再検索も案内します。

主な機能

  1. 01テーマ別に対象を絞った文書ページへ案内
  2. 02インライン OpenAPI から要求と応答の形式を確認
  3. 03最新仕様でフィールドと型を検証
  4. 04アプリの利用状況と現行仕様を比べ更新候補を確認
  5. 05リンク切れ時に全体インデックスからページを再検索
  6. 06関連する Salla スキルやツールへ振り分け

活用シーン

  1. 01API エンドポイントのフィールド、型、必須項目を確認
  2. 02最新仕様に基づいて API 呼び出しを検証
  3. 03アプリと現行 API 仕様の差分を確認
  4. 04OAuth、Webhook、アプリイベント、テーマの文書を探す

インストール

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

$npx skills add https://github.com/sallaapp/salla-partners-agent-kit --skill salla-docs

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

同梱ファイルreferences/docs-map.md

詳細

Salla ドキュメント — 適切なリファレンスを見つける

アプリ開発は Salla ドキュメントの一部にすぎません(ドキュメントには Merchant/Admin API、Twilight テーマ、ストアフロントも含まれます)。対象を絞ったページに直接進み、次の順に確認してください。

1. まずドメインスキルを確認する

各 Salla スキルには、詳細なリンクと検証済みの差分が含まれています。スキルがトピックを扱っている場合は、ドキュメントではなくそちらに従ってください(salla-app-expert は意図に応じて案内します)。スキルで解決できない場合に、ここを参照してください。

2. API の形式 → 対象を絞ったドキュメントページ(スキーマは OpenAPI をインラインで掲載)

エンドポイントの正確なリクエスト/レスポンスや、イベントのペイロードスキーマを確認するには、対象を絞ったページ(以下の表を参照)を docs.salla.dev で開き、トピックページで該当するエンドポイントまたはイベントを見つけて、公開されているスキーマをフィールド名と型の正式な情報源として参照してください。

多くのエンドポイントページには、```yaml ブロック内に OpenAPI 3.x 仕様一式 が埋め込まれています。トップレベルの項目は openapi, info, servers, paths, components, securitySchemes, security で、リクエスト/レスポンスのスキーマ、フィールドの型、列挙値、必須フィールドが含まれています。エンドポイントの正確な仕様を確認するには、https://docs.salla.dev/<id>.md ページを開いて openapi: YAML ブロックを参照してください。このブロックが正式な情報源です(例:https://docs.salla.dev/5394153e0.md = POST /orders/options)。これに基づいて呼び出しを構築・検証するには、salla-api-core の閉ループに従ってください。

最新リファレンスのワークフロー(検証とアップグレードの確認)

動作を最新の仕様に基づけるには、references/docs-map.md でリソースを見つけ → 最新の https://docs.salla.dev/<id>.md を取得し → インラインの OpenAPI ブロックを参照してください。次の用途に使います。

  • 検証 — 最新のスキーマ(フィールド名、型、列挙値、必須項目)に基づいて構築/検証します。ループの仕組みについては salla-api-core を参照してください。
  • アップグレードの確認 — 現在の仕様で利用できる機能とアプリが使用している機能を比較し、利用可能なアップグレードを提示します。
  • 鮮度の確保 — 必ず最新の情報を取得し、キャッシュされた形式は使わないでください。404 が返された場合はハンドルが変更されています。手順 3/4 に従ってページを探し直してください。

3. トピック → 対象を絞ったドキュメントの入口

インデックスではなく、対象を絞ったページを開いてください。以下の数値 URL は安定したハンドルですが、番号が変更されたり移動されたりすることがあります。ページが最新であることを確認してください。404 が返された場合は、手順 4 に従って全インデックスからページを探し直し、そのページだけを参照してください。

トピック入口
OAuth 2.0(Easy & Custom Mode)https://docs.salla.dev/421118m0.md
Webhook ガイド + イベント一覧https://docs.salla.dev/421119m0.md
アプリイベント(ライフサイクル)https://docs.salla.dev/421413m0.md
App Functions — 概要https://docs.salla.dev/1726814m0.md
App Functions — 対応イベントhttps://docs.salla.dev/1726818m0.md
ストアフロントイベント(スニペット)https://docs.salla.dev/1724504m0.md
Communication App のペイロードhttps://docs.salla.dev/1380572m0.md
Embedded SDK モジュールhttps://docs.salla.dev/embedded-sdk/overview.md
Merchant/Admin API リファレンスhttps://docs.salla.dev/421117m0.md
アプリ設定フォーム(ガイド)salla-app-settings スキル
React テーマ(Twilight エンジン)salla_themes_docs ツール、または https://docs.salla.dev/twilight/react/llms.txt

4. 最終手段:全体インデックスからページを探す

  • https://docs.salla.dev/llms.txt は、LLM 用の全体インデックスです。その大半(ストア API のリソース、テーマ/Twilight のドキュメント)はアプリ開発の対象外です。上記のスコープ対象ページの URL が 404 を返す場合に限り、ページの場所を 特定 するために使用し、そのページだけを読み込んでください。
  • Merchant API リファレンスには数百のエンドポイントがあります。必要なリソースだけを開いてください (呼び出し規約については salla-api-core を参照してください)。
  • React テーマ(Twilight エンジン)の内部仕様 — ルート、フック、コンポーネント、スロット、ストア API クライアント、Salla CLI — は専用のドキュメントセットにあります。salla_themes_docs ツールを使用するか(action=search、次に action=read。インデックスには action=list)、スコープ対象のインデックス https://docs.salla.dev/twilight/react/llms.txt を読み、その後、単一のページを Markdown 形式で読み込んでください(<page>.md)。llms-full.txt は読み込まないでください。
  • ストアフロントのスニペット UI、またはネイティブのストアフロント UI への準拠については、 salla-snippets または salla-storefront-ui を参照してください。

コミュニティとエスカレーション

チャネルリンク
Partners Portalhttps://portal.salla.partners
開発者ブログhttps://salla.dev/blog/
開発者コミュニティ(Telegram)https://t.me/salladev

コメント