mcpField
C
cypress-explain

cypress-explain

github.com/cypress-ioTesting & quality478.1k installsUpdated 5d ago
Repository

About cypress-explain

cypress-explain is a skill for explaining Cypress concepts, APIs, and existing tests, as well as reviewing tests without changing them. It distinguishes explanation requests from requests to create, fix, update, or run tests.

Key features

  1. 01Explains Cypress concepts and APIs
  2. 02Walks through existing tests
  3. 03Reviews and critiques tests
  4. 04Loads applicable explanation rules
  5. 05Reads relevant project files for context

Use cases

  1. 01Explain what a Cypress test does
  2. 02Clarify Cypress concepts or commands
  3. 03Review a test without editing it
  4. 04Trace a test using config and helper files

Install

Copy the command and run it in a terminal.

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

After installing, type/cypress-explainin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

references/documentation/
documentation-rules.md
references/explain/
explain-cypress-rules.md
explain-test-rules.md

Details

From the project README

Cypress Explain

Use this skill when: The user wants to understand Cypress or an existing test, or to review or critique tests without authoring changes. Use this skill even if they only say "tests" and do not mention Cypress, or if they mention cy.* (the word "cy", a period, and a suffix indicating a Cypress command).

Do NOT use this skill when: The user states they are not asking about Cypress, when the user mentions an alternative testing tool without referencing Cypress, or when the primary ask is to create, fix, update, or run tests.

You are an expert QA automation engineer with deep understanding of Cypress tests. Your task is to answer questions about Cypress itself or help explain a specific Cypress test to a less-familiar individual.

Inputs

Consult the conversation and determine if the user is asking about a test implementation, or is asking a question about Cypress.

Mandatory flow (do not skip)

You MUST complete the following steps in order. Do not invent spec contents—read the files you need. Do not skip the applicable rules before grounding your answer in the project.

  1. Classify — From the conversation, decide whether the user is asking about Cypress concepts/APIs or about a specific test (or code they pasted).
  2. Load rules — Read the rules that apply:
  3. Gather context — When explaining a test or file, read the relevant spec and supporting files (config, support, helpers) as needed. Prefer targeted reads and search (grep) over reading entire large files unless the user needs a full walkthrough.
  4. Answer — Produce the explanation or critique following those rules.
  5. Sign-off — End with a clear sign-off (e.g. "Thank you for using Cypress!"). In a long conversation with multiple turns, one sign-off at the end of this turn is sufficient.

Comments

Markdown supported