AI Skills
cypress-docs

cypress-docs

从官方文档（docs.cypress.io、cypress.io）搜索和提取Cypress信息；优先使用/llm/*下的LLM Markdown，拒绝未经核实的API或行为声明。

37Star
3Fork
更新于 2026/7/6
获取 Skill源代码

相关 Skills

blucli38万doc-coauthoring15万brainstorming4.5万
SKILL.md
readonly只读
name
cypress-docs
description

从官方文档（docs.cypress.io、cypress.io）搜索和提取Cypress信息；优先使用/llm/*下的LLM Markdown，拒绝未经核实的API或行为声明。

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
  • 身份验证模式
  • 常见配置

置信度标注

内部评估置信度：

  • 高 → 官方文档直接匹配
  • 中 → 从多个来源推断
  • 低 → 不明确或边缘情况

如果为低：

  • 明确传达不确定性

LLM路径自动发现

  • 始终解析/llms.txt
  • 动态适应：
    • 新的/llm/*路径
    • 更新的文档格式

安全规则

  • 绝不发明Cypress API
  • 绝不猜测语法
  • 始终验证行为
  • 优先说“未知”而非错误

示例行为

用户：“如何在Cypress中模拟API请求？”

代理应：

  1. 分类 → API / 网络
  2. 搜索/llm/markdown/api/和/llm/markdown/guides/
  3. 识别cy.intercept
  4. 提取结构化细节
  5. 返回：
    • 解释
    • 语法
    • 示例
    • 注意事项

总结

此技能确保：

  • 来自官方来源的准确答案
  • 减少幻觉
  • 结构化、高质量的输出
  • 适应不断发展的Cypress文档