核心用法
solo-audit 是一款面向知识库(Knowledge Base)的质量审计工具,专为 Markdown 密集型项目设计。通过解析 $ARGUMENTS 可选参数,用户可针对性聚焦特定检查维度(如 tags、frontmatter、links),或直接执行全量审计。工具集成 Glob、Grep、Bash 等底层能力,自动排除 .venv/、node_modules/、archive/ 等开发目录,精准定位内容文件。
显著优点
1. 多维度质量检测:覆盖 frontmatter 完整性(title/tags/type/status)、内部链接有效性、标签一致性(去重、标准化)、孤儿文件识别、内容新鲜度(30 天以上草稿)及目录覆盖度六大维度。
2. 智能 schema 识别:不依赖硬编码规则,而是通过采样现有文件自动推断 frontmatter 结构,适应不同团队的元数据规范。
3. 可操作的输出:生成结构化 Markdown 报告,包含问题文件清单、标签统计表、具体修复建议,降低人工复核成本。
4. 轻量集成:基于 MIT 许可,支持 mcp__solograph__kb_search 等外部工具链扩展,适合 Obsidian、Docusaurus、MkDocs 等主流知识库方案。
潜在缺点与局限性
- 性能瓶颈:大型知识库(10,000+ 文件)的全量扫描可能产生较高 I/O 开销,建议分目录或增量执行。
- 链接检测盲区:仅支持标准 Markdown 语法
[text](path.md),对 WikiLinks[[page]]、HTML<a>标签或动态路由解析能力有限。 - 语义分析缺失:标签相似度判断基于字符串匹配(如 "AI" vs "artificial-intelligence"),无法识别语义等价但拼写迥异的标签(如 "llm" vs "大语言模型")。
- 跨文件引用依赖:孤儿文件检测依赖
related:字段,若项目使用其他关联机制(如 Obsidian 的双向链接),可能出现误判。
适合人群
- 技术文档工程师与开发者体验(DX)团队
- 使用 Obsidian/Notion 导出 Markdown 进行版本管理的个人知识管理(PKM)用户
- 开源项目维护者需定期同步文档站点与代码仓库
常规风险
- 误删风险:工具本身只读,但用户依据 "孤儿文件" 报告执行删除前,应二次确认文件是否真的未被外部系统(如网站导航、脚本生成)引用。
- 隐私泄露:审计报告可能暴露目录结构、草稿标题等敏感元数据,建议输出至安全位置或脱敏后分享。
- 自动化依赖:自动推断的 schema 可能随采样偏差而波动,关键项目建议辅以人工校验规则。