用途:检查文档是否符合 Elastic 风格指南,借助 Vale 输出和风格规则报告问题,不自动修复。
主要能力:按 Voice/Tone、Word Choice、Grammar/Spelling、Formatting、Accessibility、UI Writing 分类列出行号、问题与建议;先刷新风格指南,再获取 Vale 结果,然后人工复核。
使用方式:参数为待检查文件或目录,为空时询问。先用 Elastic docs MCP 的 get_document_by_url 并设 includeBody: true 获取指南;若 MCP 不可用则直接抓取 .md 页面。若输入文件已含 Vale 输出则直接读取;否则运行 vale --output=line $ARGUMENTS。CLI 不在 PATH 时先找二进制(如 /tmp/gh-aw/bin/vale);都没有则跳过并注明,改为人工复核。之后读取 .md 文件全部内容逐条核对规则。
报告:按区域分组,格式为“文件与行号、区域、问题、建议”,给出汇总统计与一行总结;无问题需说明。
限制:只报告不修改;需网络或 MCP 获取指南;Vale 不可用时缺少自动检查;规则细节多,以资料列出的风格指南为准。