SuperAPI AI 工具集

docs-content-type-checker

通用与其它

查看项目

更新于 10-15 21:37

技能介绍

用途:这是 Elastic 文档的内容类型合规检查工具,支持两种模式。Validate 模式评估已有页面(文件、目录或粘贴内容)是否符合内容类型规范并报告问题;Classify 模式根据未撰写页面的简短描述,判断最合适的内容类型并列出仍需补充的必需元素。\n\n主要能力:根据输入自动判断模式;从 frontmatter 的 type 字段识别内容类型(合法值:overview、how-to、tutorial、troubleshooting、changelog),缺失时从结构推断并提示;优先通过 elastic-docs MCP 的 get_document_by_url 获取规范页(includeBody 设为 true),不可用时用 WebFetch 抓取 .md 版本规范与模板。检查项覆盖共享 frontmatter 与元数据、各内容类型的必需内容、推荐内容与反模式。输出结构化报告:检测类型、必需元素逐项通过/缺失、最佳实践提示、摘要统计;分类模式输出最佳匹配、置信度、理由、待起草元素与替代方案。\n\n使用方式:参数 $ARGUMENTS 传入文件路径或目录、粘贴的页面内容(进入 Validate 模式),或页面意图描述(进入 Classify 模式);留空时向用户询问。模式不明时先提一个聚焦问题,不猜测。\n\n适用场景:Elastic 文档贡献者写作前判定内容类型,或提交前校验页面是否符合规范。\n\n限制:规范以抓取内容为准,与内置清单冲突时优先抓取结果;若抓取清单用 product 而目标仓库用 products,以仓库的规范 schema 为准并说明不一致;描述过短(约少于 10 个有效词)无法分类时需先澄清;低置信度时不强行归类,建议检查是否应作为已有页面的新章节。具体安装与配置方式资料未提供。