SuperAPI AI 工具集

docs-review

写作与研究

查看项目

更新于 10-15 20:21

技能介绍

用途:审查文档改动是否符合 Metabase 写作风格指南,适用于审阅包含文档的拉取请求(PR)、文件或 diff。

主要能力:先检测审查模式。若可用 mcp__github__create_pending_pull_request_review 工具,则进入 PR 审查模式,通过待处理审查工作流把所有问题作为一次整体审查发布;若该 MCP 工具不可用,则进入本地审查模式,在对话中以编号 Markdown 列表输出问题。审查清单覆盖语气与措辞(如正式用语、用 users 而非 people/companies、过度感叹号)、结构与清晰度(重点被埋没、冗长、标题含糊、把任务说成 easy/simple)、链接与引用(用 here 作链接文字、标题内链接)、格式(用 & 代替 and、列表格式不一致)、代码与示例(示例无法运行、命令顺序错误、整屏截图、多余图片)以及句子构造。

使用方式:先通读改动理解意图,再逐项检查违反风格指南或显著影响可读性的问题,只标记值得提出的问题。所有反馈必须从 Issue 1 开始连续编号。本地模式格式为“Issue N: [简短标题]”加行号、说明与建议修改。PR 模式流程:用 mcp__github__create_pending_pull_request_review 开始待处理审查;用 mcp__github__get_pull_request_diff 获取 diff 与行号;收集全部问题并连续编号;用 mcp__github__add_pull_request_review_comment_to_pending_review 为每个问题添加评论,须在单次响应中并行提交全部评论,每条评论以“Issue N: [简短标题]”开头;最后用 mcp__github__submit_pending_pull_request_review 提交,事件类型用 COMMENT(非 REQUEST_CHANGES),不填写正文。

限制:PR 模式不向对话输出摘要,仅发布 GitHub 评论;提交审查时不带 body 参数。最终需删除对读者无实质影响的问题,并核对编号连续、格式一致。资料未提供该技能的安装命令、收费与平台信息。