The @guildai-services/guildai~cypress package provides agents with read-only access to Cypress Cloud test reporting data through an LLM-mediated interface.
Authentication
- Type: API key
- Token expiration: None — API keys are long-lived
Setup
Open Credentials
Go to Credentials in Guild.
Connect Cypress
Click Cypress and enter your Cypress Cloud API key.
Locate your key
Find your API key in Cypress Cloud under Organization Settings > Enterprise Reporting.
Enterprise Reporting API access is required. This is not available on all Cypress plans.
Usage
import { cypressTools } from "@guildai-services/guildai~cypress"
import { llmAgent } from "@guildai/agents-sdk"
export default llmAgent({
description: "An agent that analyzes Cypress test results",
tools: { ...cypressTools },
})
How it works
Unlike other services that map directly to REST endpoints, the Cypress service uses an LLM-mediated approach. Agents describe what data they need in natural language, and the system selects the appropriate report.
API endpoints
| Operation | Method | Path | Description |
|---|
cypress_call | POST | /call | Execute a natural language instruction against the Cypress Cloud API |
Available reports
The cypress_call endpoint dispatches to these reports based on the instruction:
| Report | Report ID | Required parameters | Optional parameters |
|---|
| Projects | project-list | start_date | |
| Spec details | spec-details | start_date | end_date, project_id |
| Flake rate | flake-rate-per-project-over-time | start_date | end_date |
| Usage per project | usage-per-project-summary | start_date | end_date |
| Test suite size | test-suite-size-summary | start_date | end_date |
yyyy-MM-dd format.
Webhook events
Cypress does not support webhook triggers in Guild. This integration is API-access only.
Limitations
- Read-only reporting data — no creating or managing test runs
- Request timeout is 60 seconds per report
- No webhook or trigger support
