SuperAPI AI 工具集

codebase-summary

数据与分析

查看项目

更新于 10-16 06:48

技能介绍

用途:分析代码库并生成完整文档,包括描述系统架构、组件、接口和工作流的结构化元数据文件,方便 AI 助手理解系统并协助开发。

主要能力:生成 index.md 知识库索引,以及 architecture.md、components.md、interfaces.md、data_models.md、workflows.md、dependencies.md 等文档;可检查文档一致性与完整性并写入 review_notes.md;支持 update_mode 基于 git 提交增量更新;可将内容合并到根目录的 AGENTS.md、README.md、CONTRIBUTING.md 或自定义文件。所有可视化使用 Mermaid 图,不使用 ASCII 艺术。

主要参数:output_dir(默认 .sop/summary)、consolidate(默认 false)、consolidate_target(默认 AGENTS.md)、consolidate_prompt、check_consistency(默认 true)、check_completeness(默认 true)、update_mode(默认 false)、codebase_path(默认当前目录)。

使用方式:一次性提供全部参数,支持直接文本、文件路径或目录路径等输入;确认参数后校验 codebase_path 是否存在,创建输出目录,分析结构,生成文档,审查,按需合并,最后给出摘要与后续建议。若 consolidate 为 false,则忽略 consolidate_target 与 consolidate_prompt。

适用场景:为项目生成 AI 可读文档、维护 AGENTS.md、基于近期提交更新文档、识别文档缺口。

限制:大型代码库分析可能耗时,建议提供进度更新或聚焦特定目录;update_mode 依赖可访问的 git 历史;合并效果取决于 consolidate_prompt 的清晰度;语言支持有限可能造成文档缺口。具体收费、价格与平台信息暂未提供。