mcpField
A
antithesis-documentation

antithesis-documentation

github.com/antithesishq测试与质量302606 次安装1 周前更新
代码仓库

关于 antithesis-documentation

antithesis-documentation 是依据 Antithesis 文档回答平台行为、SDK、设置和测试实践问题的技能。它指导使用 snouty 在命令行检索文档,并在该 CLI 不可用时提供直接读取 Markdown 的备用流程。

主要功能

  1. 01通过 snouty docs 浏览文档
  2. 02按目录树和搜索探索页面
  3. 03读取完整文档页面
  4. 04使用直接 Markdown 作为备用方式
  5. 05基于引用文档撰写回答

适用场景

  1. 01查找 Antithesis SDK 指南
  2. 02核对设置与测试实践
  3. 03从命令行检索文档主题

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/antithesishq/antithesis-skills --skill antithesis-documentation

安装后在 Claude Code 中输入/antithesis-documentation确认已加载。

详细介绍

Antithesis 文档

技能版本: 2026-10-21 4f8d80b

Antithesis 概述

Antithesis 是一个测试平台,类似于专用的预发布环境。你可以将软件部署到 Antithesis 并在那里运行,然后再部署到生产环境,以确保软件可靠。它补充了现有的测试工具,并与日常 CI/CD 工作流并行运行。

部署到 Antithesis 后,你的软件会在一个比生产环境严苛得多的模拟环境中运行。这能快速暴露错误,包括复杂、罕见和严重的故障。

由于 Antithesis 的环境完全确定,因此只需付出极少努力就能复现问题。与常见的共享预发布环境不同,你无需争抢部署锁,也不必担心环境漂移,因为每次部署彼此完全隔离。

访问文档

在命令行中访问 Antithesis 文档的最佳方式是使用 Antithesis CLI,即 snouty。

运行 snouty docs --help 即可开始。

如果缺少 snouty

  1. 告诉用户 snouty 是 Antithesis CLI。
  2. 指引他们访问安装来源:https://github.com/antithesishq/snouty
  3. 询问他们是否希望你安装。如果希望,请按照 https://raw.githubusercontent.com/antithesishq/snouty/refs/heads/main/README.md 中的说明操作。
  4. 安装后,重新运行 snouty --help。

如果 snouty --version 显示的版本低于 0.8.0,请先运行 snouty update。

使用 snouty docs

提供详细指导前,使用 snouty docs 查找权威的 Antithesis 文档。查看 snouty docs --help,了解子命令和用法示例。

推荐工作流:

  1. 从 snouty docs tree --depth 2 开始,快速了解文档概况。
  2. 如果知道要查找的领域但不知道确切页面名称,可使用 snouty docs tree <filter> 浏览相应部分。
  3. 使用 snouty docs search <terms> 查找特定主题可能涉及的页面。
  4. 如果只想查看页面路径,可使用 snouty docs search -l <terms>。
  5. 确定路径后,使用 snouty docs show <path> 阅读完整的 Markdown 页面。
  6. 在回答中引用相关文档页面。

实用信息:

  • snouty docs show 接受 using_antithesis/sdk/go 之类的页面路径。
  • snouty docs show 也接受 /docs/.../ 格式的路径,并会尝试为你规范化路径。
  • 如果更新文档失败并回退到缓存文档,通常无需担心;尤其是在无法访问网络的沙盒环境中。如果仍返回了所需的文档内容,可将其视为非致命问题。
  • snouty docs sqlite 会输出本地 SQLite 数据库的路径,其中包含所有 Antithesis 文档。若想直接查询文档,可使用此数据库。

Markdown 直接回退方案

如果无法使用 snouty,可以直接从 https://antithesis.com/docs/ 获取 Markdown 页面。

所有 Markdown 页面的纯文本索引位于 https://antithesis.com/docs/llms.txt。请先加载此索引。

从 https://antithesis.com/docs/ 请求文件前,始终先添加 .md 扩展名。

示例:

  • https://antithesis.com/docs/reference/sdk/go/ 转换为 https://antithesis.com/docs/reference/sdk/go.md
  • /reference/sdk/go/ 转换为 https://antithesis.com/docs/reference/sdk/go.md

例外情况:

  • 带有明确文件扩展名的 URL,例如 .txt、.js 或 .so
  • docs/generated/... 路径应按原样请求

向用户提供链接时,优先使用常规 HTML 页面 URL,而不是 .md URL。

如果想直接链接到某个章节,在适用时使用根据标题生成的片段标识符。如果无法确定片段标识符,请链接到页面并明确指出章节名称。

输出

  • 关于 Antithesis 行为、SDK、设置和最佳实践的清晰、可靠的回答。
  • 提供所用文档页面的相关链接。
  • 如果缺少 snouty 命令,请询问用户是否想安装,并告知他们这是一个用于使用 Antithesis API 和文档的 CLI。

自我检查

在宣布此技能完成之前,请根据以下标准检查你的工作。此技能的输出是对话式的(基于文档提供回答),因此应在当前上下文中进行检查。重新阅读此文件中的指南,然后逐项对照以下标准,系统地检查你给出的回答。

检查标准:

  • 回答中的每项事实性陈述都基于你通过 snouty docs 或直接获取 Markdown 所查阅的具体文档页面
  • 已附上文档页面链接,方便用户核实来源
  • 没有混淆不同页面中的概念,也没有添加源材料中未提及的细节
  • 如果文档对某个问题含糊不清或未作说明,应明确指出,而不是根据假设补全

评论

支持 Markdown