SuperAPI AI 工具集

maintain-skills-readme

编程与开发

查看项目

更新于 10-15 21:49

技能介绍

用途:该技能用于维护 agent-skills、Codex plugin、Claude plugin 等技能或插件仓库的专用 README.md,通过一条确定性工作流完成审计与受控修复。处理旧式提示时,skills_readme_alignment 仅作兼容使用。不适用于普通软件项目 README,那种场景应改用 maintain-project-readme。

主要能力:检查 README 的章节结构、安装命令、技能清单措辞以及技能/插件的可发现性规则;输出 Markdown 加 JSON 报告,字段包括 run_context、repos_scanned、profile_assignments、schema_violations、command_integrity_issues、fixes_applied、post_fix_status 和 errors;若无问题且无错误,输出恰为 No findings。

使用方式:输入参数中 --workspace <path> 为必填,可选 --repo-glob <glob>、可重复的 --exclude <path> 以及 --apply-fixes。流程为先校验工作区路径并发现匹配仓库,先运行只读审计,检查上述各项;如用户要求编辑,则用 --apply-fixes 应用有界修复,再次运行同一审计确认剩余问题,最后返回 Markdown 加 JSON 报告。

限制与护栏:绝不自动提交、自动推送或创建 PR;绝不编辑源代码、清单、锁文件或 CI 文件;编辑仅限 README.md 及经明确批准的向 AGENTS.md 插入的片段。参考资料包括 references/output-contract.md、references/skills-readme-maintenance-automation-prompts.md、references/profile-model.md、references/section-schema.md、references/discoverability-rules.md、references/fix-policies.md。具体收费、平台与效果等资料暂未提供。