SuperAPI AI 工具集

codebase-exploration

通用与其它

查看项目

更新于 10-15 21:51

技能介绍

用途:借助 SocratiCode MCP 工具高效探索和理解代码库,核心原则是“先搜索再阅读”——索引能毫秒级给出代码地图,直接读原始文件成本高且占用上下文。

主要能力与用法:

  1. 以 codebase_search 起步。它单次调用融合向量与 BM25(RRF 融合)的语义+关键词混合搜索;宽泛查询用于定位(如认证处理、数据库连接、错误处理模式),精确查询用于符号查找。可用 fileFilter 限定文件路径、languageFilter 限定语言、minScore(默认 0.10)调节精度与召回。已知确切标识符或正则时,grep/ripgrep 更快更准。
  2. 先看图再追导入。codebase_graph_query 查看某文件导入及被依赖情况;codebase_graph_stats 给出文件总数、边、连接最多的文件、孤立文件与语言分布;codebase_graph_circular 找循环依赖;codebase_graph_visualize 生成按语言着色的 Mermaid 图(循环依赖标红),mode="interactive" 可打开离线自包含 HTML 探索器。图在索引后自动构建,可用 codebase_graph_status 检查;在 SOCRATICODE_WATCHER=manual 或 off 下,图查询不会创建缺失图,需显式运行 codebase_graph_build。
  3. 搜索定位到 1-3 个文件后再读相关片段,不要为判断相关性而整读文件。
  4. 用上下文工件获取非代码知识:项目可定义 .socraticodecontextartifacts.json 暴露数据库模式、API 规范、基础设施配置、架构文档等。codebase_context 列出工件,codebase_context_search 做语义搜索(可用 artifactName 过滤),首次搜索自动索引并检测过期。
  5. 异常时检查 codebase_status(索引状态、进度、watcher、图状态)。无结果可能未索引;watcher 未激活结果可能过期,可运行 codebase_update。快照模式(SOCRATICODE_WATCHER=off 且 SOCRATICODE_AUTO_RESUME=off)下结果本就可能过期,需显式更新,不要启用 watcher。Git 模式(SOCRATICODE_WATCHER=git)下搜索、图、状态会报告刷新状态,未验证结果不应视为当前。
  6. codebase_about 提供全部工具速查与典型工作流。

限制:搜索无结果通常意味着项目未索引;watcher 关闭时结果可能过期;快照模式与 Git 模式下需注意结果时效,不应擅自启动文件 watcher。各工具完整参数见其工具参考文档。