DocOrbit 是一个面向编码智能体的版本感知文档智能工具,由 HakashiKatake 开发,采用 MIT 许可证。其核心目标是解决 AI 编码智能体因文档上下文缺陷而生成错误代码的问题。
用途
DocOrbit 用于为编码智能体提供准确、版本匹配的文档上下文,并验证生成的代码是否符合文档契约。它针对以下常见问题:版本冲突(如在 Next.js 14 项目中误用 Next.js 15 文档)、HTML 冗余(浪费上下文窗口)、缺少 API 契约、过时示例与弃用接口、以及第三方文档中的提示注入风险。
主要能力
- 文档智能:自动探测目标域名并排序可用格式(llms-full.txt > openapi.json > llms.txt > skill.md > Markdown > HTML sitemap);根据意图(导航、概念、API、示例、实现)动态排序来源;语义 AST 切片保留标题层级、面包屑和不可分割代码块。
- 版本智能:扫描 8 个生态(npm、cargo、go、pypi、composer、rubygems、pub、maven)的工作区清单;通过 SemVer 置信阶梯确定性解析项目版本;生成确定性的 docs.lock 锁定文档版本。
- 实现知识:解析 OpenAPI 3.x 与 Swagger 2.0(参数、JSON 请求/响应模式、认证、分页头,安全处理 $ref 循环);提取并索引按语言和框架分类的代码示例;索引破坏性变更、服务端/客户端边界、速率限制和安全陷阱;组装带证据等级的实现蓝图。
- 闭环验证:静态 AST 代码验证器,无需调用 LLM 即可评估 JavaScript、TypeScript、Python 和 cURL 代码;严格契约检查(端点路径、HTTP 方法、必需参数、弃用 API);对动态表达式返回 insufficient_evidence 以避免误报。
- 变更智能:文档差异比较(diff_docs)检测新增、修改、删除和弃用的端点;工作区影响分析(analyze_impact)扫描仓库源文件定位受影响行。
- 智能体集成:提供 15 个 MCP 工具,支持 stdio 和 Streamable HTTP;返回为智能体消费设计的 token 预算 Markdown;生成 AGENTS.md、CLAUDE.md、skill.md、llms.txt 和 docs-map.md 等导出文件。
使用方式
DocOrbit 要求 Node.js ≥ 22.5.0,零外部运行时依赖。可通过 npx 零安装运行。默认使用项目级存储(<projectRoot>/.docorbit/docorbit.db),删除或分支项目时缓存自动隔离清理。连接编码智能体(Cursor、Claude Desktop、Windsurf、Zed)时,DocOrbit 自动解析到活动项目工作区的 SQLite 数据库;若需跨项目共享存储,可传递 -g 标志。在提示中,用户只需给智能体官方文档链接并指示使用 DocOrbit,智能体将自动调用 ingest_doc 爬取索引、get_implementation_context 组装上下文、check_api 验证代码。交互式终端中运行 docorbit init 或 docorbit add <url> 会提示选择项目级或全局存储;非交互环境自动默认项目级。
适用场景
适用于使用 AI 编码智能体的开发团队和个人,特别是在多版本依赖、需要严格 API 契约验证、或关注文档安全性的项目中。
限制
文档未提供具体收费、价格或平台支持信息。安全方面,DocOrbit 将外部文档视为不可信输入,提供 SSRF 防护、非破坏性安全标注和资源限制(默认 10MB 流式字节限制)。性能方面,冷启动 < 40ms,索引约 24ms。仓库包含可复现的 17 任务基准测试套件。