Skip to content

Commit ef1b336

Browse files
expand limitations / reorder messaging
1 parent 8267531 commit ef1b336

File tree

1 file changed

+27
-13
lines changed

1 file changed

+27
-13
lines changed

docs/api/commands/prompt.mdx

Lines changed: 27 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -718,28 +718,30 @@ cy.prompt(electronicsFilterPrompt)
718718

719719
## Limitations
720720

721+
These apply to all `cy.prompt` usage unless noted otherwise.
722+
723+
### General limitations
724+
721725
| Limitation | Details |
722726
| ---------------- | ------------------------------------------------------------------------ |
723727
| Authentication | Requires Cypress Cloud account and/or valid record key |
724728
| Test Type | E2E tests only (component testing not yet supported) |
725729
| Browser Support | Chromium-based browsers only (Chrome, Edge, Electron) |
726730
| Language Support | Optimized for English prompts; other languages are not guaranteed |
727-
| Assertions | 'not.exist' assertions are not supported |
728-
| DOM Support | Canvas and iframe elements are not supported |
729731
| Command Coverage | Not all Cypress APIs supported - see [What you can do](#What-you-can-do) |
730-
| Step Limit | Each `cy.prompt` call is limited to 50 steps |
731-
732-
### Step limit details
733-
734-
Each `cy.prompt` call is limited to 50 steps. This constraint helps maintain the accuracy and reliability of AI-generated test code. As the number of steps increases, the AI model's ability to maintain context and generate precise, executable Cypress commands may decrease. By keeping prompts focused and concise, you'll get more reliable results and better test performance.
735-
736-
:::note
737732

738-
**System-wide prompt length limits**
733+
### Experimental release limitations
739734

740-
During the experimental release, we have system-wide limits on the total input length processed by `cy.prompt`. If you encounter issues with longer prompts, consider breaking them into smaller, more focused `cy.prompt` calls.
735+
The `cy.prompt` command is currently in experimental release. During the experimental release, there are some limitations that we intend to address in the future.
741736

742-
:::
737+
| Limitation | Details |
738+
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
739+
| Assertions | 'not.exist' assertions are not supported [See issue](https://github.com/cypress-io/cypress/issues/32793) |
740+
| Multi-Element | Assertions on multiple elements are not currently supported [See issue](https://github.com/cypress-io/cypress/issues/32787) |
741+
| Cookies/Sessions | Clearing cookies or sessions is not supported [See issue](https://github.com/cypress-io/cypress/issues/32810) |
742+
| Scrolling | Scrolling to elements is not supported [See issue](https://github.com/cypress-io/cypress/issues/32789) |
743+
| API Testing | API requests (e.g., cy.request() or cy.intercept()) are not supported [See issue](https://github.com/cypress-io/cypress/issues/32792) |
744+
| DOM Support | Canvas and iframe elements are not supported. See [canvas issue](https://github.com/cypress-io/cypress/issues/32830) and [iframe issue](https://github.com/cypress-io/cypress/issues/32800) |
743745

744746
## Pricing & usage limits
745747

@@ -751,7 +753,9 @@ Please note that pricing and usage limitations are subject to future adjustments
751753

752754
:::
753755

754-
### Usage limits
756+
There are two sets of limits: per-user hourly limits and per-prompt limits.
757+
758+
### Per-user hourly limits
755759

756760
_Usage limits only apply to runs that are not recording to Cypress Cloud._
757761

@@ -765,6 +769,16 @@ _Usage limits only apply to runs that are not recording to Cypress Cloud._
765769
- 600 prompts per hour
766770
- 3,000 prompt steps per hour
767771

772+
### Per-prompt limits
773+
774+
- Up to 50 steps per `cy.prompt` call to maintain context fidelity and produce reliable, executable commands.
775+
- During the experimental release, system-wide limits apply to the total input length processed by `cy.prompt`. Very long prompts may be rejected or require splitting.
776+
777+
To improve reliability and performance, consider the following:
778+
779+
- Keep one action or assertion per step.
780+
- Split long flows into multiple `cy.prompt` calls.
781+
768782
## Privacy & security
769783

770784
For detailed information about how Cypress protects your data and manages AI model security, see our [Security & Compliance page](https://www.cypress.io/security).

0 commit comments

Comments
 (0)