$ cat ~/map/doc-bridge.md
doc-bridge
跨运行时文档到交接的框架:把仓库文档、ownership 映射和人类文档转成确定的 AgentHandoff 契约,可被 Cursor、Claude、Copilot 与 pi 消费。
tools✓ 10月16日
事实速查
- GitHub Stars
- ★ 9
- Forks
- 1
- 许可证
- MIT
- npm / 月
- —
- 最后推送
- 2026年10月15日
安装
pi install npm:@agentskit/doc-bridge## 速览
把仓库文档、ownership 映射与人类文档站点变成确定性 AgentHandoff 契约的框架——从哪里读起、能改哪些包、用什么检查验证——CLI(ak-docs)、MCP、CI 与 pi 技能四个入口共用同一套答案。
## 要点
- $交接是一份路由契约,字段为 startHere、editRoots、checks 与 humanDoc;终端、MCP、CI 与可选的 RAG/聊天共用同一份契约。
- $核心不需要任何 LLM 或 API key——明确声明不是 wiki、也不是托管 RAG;可选的聊天层只是架在确定性索引之上的一个界面。
- $交付面包括 ak-docs CLI(query、search、ask、doctor、gate)、只读 MCP 服务器(handoff.resolve 等工具)以及内置的 GitHub Action——在 PR 上拦截过期索引与失效的人类文档链接;文档适配器覆盖 fumadocs、docusaurus、vitepress、starlight、nextra 与纯 markdown,monorepo 路由支持 pnpm-monorepo 与 nx。
- $双向桥接:ak-docs memory 的 ingest、classify 与 promote --pr 读取 .agent-memory/** 与 .cursor/rules/*.mdc,把代理记忆分类成应转为项目文档的内容,并经 gh 开出交人工评审的草稿 PR。
- $Pi 用户用 pi install npm:@agentskit/doc-bridge 安装可移植的 skills/doc-bridge-handoff 技能——优先走只读 MCP 工具,回退到固定版本、零凭据的 CLI 解析器,绝不自行改文件、执行返回的检查或越出 editRoots 授权。
- $60 秒体验无需任何配置:npm i -D @agentskit/doc-bridge 后运行 npx ak-docs demo --text(或 npx ak-docs demo --fixture monorepo --text)。
## 常见问题
Q pi 里的 agent 怎么用它?
pi install npm:@agentskit/doc-bridge 会以开放的 Agent Skills 布局注册源内维护的技能;动手改代码前先解析失败即关闭(fail-closed)的交接契约(startHere、editRoots、checks),且从不代改文件或代跑返回的检查。
Q 会把我的项目数据发到哪里吗?
本地 MCP 服务器只读取经 doc-bridge.config.json 选定的项目——不需要 API key、不收集遥测、八个 MCP 工具不写项目文件,也不把项目数据发给 AgentsKit。
## 参考链接
## 相关条目
最后更新: 2026年8月31日