Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.guild.ai/llms.txt

Use this file to discover all available pages before exploring further.

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

1

Open Credentials

Go to Credentials in Guild.
2

Connect Cypress

Click Cypress and enter your Cypress Cloud API key.
3

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

OperationMethodPathDescription
cypress_callPOST/callExecute a natural language instruction against the Cypress Cloud API

​
Available reports

The cypress_call endpoint dispatches to these reports based on the instruction:
ReportReport IDRequired parametersOptional parameters
Projectsproject-liststart_date
Spec detailsspec-detailsstart_dateend_date, project_id
Flake rateflake-rate-per-project-over-timestart_dateend_date
Usage per projectusage-per-project-summarystart_dateend_date
Test suite sizetest-suite-size-summarystart_dateend_date
All date parameters use 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