mcpField
C
cypress-docs

cypress-docs

github.com/cypress-ioテスト・品質478.3k 回インストール5 日前に更新
リポジトリ

cypress-docs について

cypress-docsは、Cypressの公式ドキュメントから正確で検証可能な情報を得るためのエージェント向けスキルです。LLM向けの構造化ページを優先し、記憶に頼らず出典を確認します。

主な機能

  1. 01Cypress公式情報を優先
  2. 02llms.txtでページを探索
  3. 03/llm/*の構造化コンテンツを利用
  4. 04バージョン固有の挙動を確認
  5. 05未確認のAPIに関する断定を回避

活用シーン

  1. 01CypressのコマンドとAPIの確認
  2. 02設定やCLIの詳細の検索
  3. 03E2Eとコンポーネントテストの挙動比較
  4. 04公式ドキュメントに基づく説明

インストール

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

$npx skills add https://github.com/cypress-io/ai-toolkit --skill cypress-docs

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

詳細

Cypress のドキュメント

目的

公式ドキュメントと構造化された情報源を優先し、Cypress テストフレームワークに関する正確で最新かつ検証可能な情報をエージェントが取得できるようにします。

使用するタイミング

一般的なテストの知識ではなく、Cypress のドキュメントを探す、読む、引用する必要があるタスクでは、いつでもこのスキルを適用してください。

  • 事実を調べる:Cypress がドキュメントに記載しているコマンド、API、アサーション、ライフサイクルフック、設定オプション、環境変数、CLI フラグ、プラグイン、TypeScript の型を調べます。
  • 動作を確認する:特定の Cypress バージョンでの動作、E2E テストとコンポーネントテストの違い、ブラウザーのサポート、ネットワークや cy.intercept の動作を確認します。
  • 「Cypress は……できる/できない」と断言する前に:まずドキュメントを検索してください。正確なシグネチャ、デフォルト値、非推奨 API について、記憶だけに頼らないでください。
  • 構造化されたコンテンツを抽出する:ドキュメントのページを取得または要約する場合は、以下の LLM 向け最適化ドキュメント戦略(llms.txt、/llm/*)に従ってください。
  • 回答の根拠を示す:ユーザーに Cypress を説明するとき、例を書くとき、または正確性を公式ドキュメントに一致させる必要があるコードをレビューするときに使います。

ユーザーが必要としているのが、ドキュメントを調べずにテストを書いたり修正したりすることだけの場合は、cypress-author を優先してください。ドキュメントを取得せずにテストの説明だけを行う場合は、cypress-explain を優先してください。公式ドキュメントを情報源として扱う場合は、このスキルを使ってください。

情報源の優先順位

主要な情報源(必ず最初に検索)

🤖 LLM 向け最適化ドキュメント戦略

docs.cypress.io にアクセスするときは、次の手順に従ってください。

  1. /llms.txt を取得します。

  2. 内容を解析し、次の情報を特定します。

    • LLM 向けに最適化されたドキュメントのパス
    • 構造化されたコンテンツのエンドポイント
  3. /llm/* 以下のコンテンツを優先します。サイト上のすべてのパスには、/llm 以下に最適化版があります。たとえば、https://docs.cypress.io/app/faq は https://docs.cypress.io/llm/markdown/app/faq.md で利用できます。

  4. 理由:

    • Markdown/JSON 形式
    • より明確な構成
    • HTML よりも不要な情報が少ない
  5. フォールバック:

    • /llm/* に不足がある場合は、標準のドキュメントページを使います。

重要なルール

不明な機能を決めつけない
  • Cypress が機能をサポートしていないと決して決めつけないでください。
  • 結論を出す前に必ず検索してください。
  • 必要に応じて別の用語でもう一度検索してください。
幻覚を防ぐためのガード

ドキュメントで主張を検証できない場合:

  • 「Cypress のドキュメントでは確認できませんでした」と伝えてください。
  • (可能であれば)最も近い、サポートされている代替案を提示してください。
  • API や動作を捏造しないでください。

検索戦略

1. クエリを分類する
クエリの種類検索場所
使い方.../guides/, /core-concepts/
概要.../core-concepts/
API/コマンド/api/commands/
アサーション/api/assertions/
設定の問題/configuration/
CI/CD/guides/ci-cd/
エラー/references/error-messages/
2. 検索の流れ
  1. /llm/*(/llms.txt 経由)
  2. 標準のドキュメントページ
  3. /changelog/
  4. cypress.io(ブログ、更新情報)
3. エラーに応じた検索先の振り分け

クエリに次の内容が含まれる場合:

  • エラーメッセージ
  • スタックトレース

次の手順に従ってください。

  1. /references/error-messages を検索します。
  2. ガイドと API ドキュメントも調べます。

構造化された情報の抽出ルール

コマンド
  • 構文
  • 必須引数
  • 任意のオプション
  • 戻り値の動作
  • 使用例
概念
  • 定義
  • 主なルール
  • よくある落とし穴
  • 例
設定
  • オプション名
  • 型
  • デフォルト値
  • 例

バージョンへの配慮

  • Cypress のバージョンが指定されている場合は特定します。
  • 指定されていない場合は、最新の安定版を前提とします。
  • バージョンによって動作が異なる場合:
    • その違いを明確に説明します。

回答スタイルのガイドライン

  • 公式の例を優先します。
  • 動作するコードスニペットを提示します。
  • 簡潔でありながら、必要な情報を網羅した回答にします。
  • 推測は避けます。

キャッシュ戦略(任意)

頻繁に使われるトピックをキャッシュします。

  • cy.visit
  • cy.get
  • cy.intercept
  • 認証パターン
  • 一般的な設定

信頼度の注釈

内部で信頼度を評価します。

  • High → 公式ドキュメントに直接記載あり
  • Medium → 複数の情報源から推定
  • Low → 不明瞭、またはエッジケース

LOW の場合:

  • 不確実であることを明確に伝えます

LLM パスの自動検出

  • 常に /llms.txt を解析します
  • 次の内容に動的に適応します。
    • 新しい /llm/* パス
    • 更新されたドキュメント形式

安全ルール

  • Cypress API を決して創作しないでください
  • 構文を決して推測しないでください
  • 動作を必ず検証してください
  • 誤った情報を示すより「不明」とすることを優先してください

動作例

ユーザー:「Cypress で API リクエストをモックするにはどうすればよいですか?」

エージェントは次のように対応します。

  1. 分類 → API/ネットワーク
  2. /llm/markdown/api/ と /llm/markdown/guides/ を検索
  3. cy.intercept を特定
  4. 構造化された詳細情報を抽出
  5. 次の内容を返します。
    • 説明
    • 構文
    • 例
    • 注記

まとめ

このスキルにより、次のことが実現します。

  • 公式ソースに基づく正確な回答
  • ハルシネーションの低減
  • 構造化された高品質な出力
  • 進化する Cypress ドキュメントへの適応

コメント