Docs your agents can act on
Turn repo docs into executable handoffs.
doc-bridge gives every coding agent the same contract: startHere, editRoots, checks, and humanDoc. Then it turns agent memory back into reviewable documentation drafts. Use it from CLI, MCP, and CI. No LLM or API key required.
# Before — agent guesses
✗ edits packages/billing when task says "auth"
✗ runs repo-wide test instead of package checks
$ npx ak-docs demo --text
# After — handoff.resolve
✓ target: auth (packages/auth)
✓ edit: packages/auth
✓ checks: pnpm --filter @demo/auth test
✓ human guide: /docs/guides/auth
Gate: red → green
$ npm i -D @agentskit/doc-bridge
$ npx ak-docs init && npx ak-docs index
$ ak-docs mcp install --cursor
$ ak-docs doctor --text
Score: 82/100 (B)
Agent docs: 8/10 (80% handoff-ready)
Human guides: 6/10 (60% bridged)
Gates: 3/3 passing
→ ak-docs query package auth --agent
Use it where agents already work
One index, multiple surfaces. Start with the CLI; wire MCP and CI when the first handoff is useful.
| Surface | What it does | How you use it |
|---|---|---|
| CLI | Query ownership, inspect handoffs, run doctor, search docs. | ak-docs query package auth --agent |
| MCP | Lets Cursor, Claude Code, and Codex-style agents resolve before editing. | ak-docs mcp install --cursor |
| CI | Blocks stale indexes and broken human-doc bridges. | ak-docs index && ak-docs gate run |
| Adapters | Connect Fumadocs, Docusaurus, VitePress, Starlight, Nextra, plain markdown, and pnpm workspaces. | fumadocs · docusaurus · vitepress · starlight · nextra · plain-markdown |
| Memory pipeline | Classifies local agent memory and drafts documentation updates. | ak-docs memory promote --pr |
| Optional RAG/chat | Adds handoff-first chat when you install AgentsKit peers. | ak-docs rag ingest && ak-docs chat |
Four loops, one bridge
Act, bridge, learn, explain — each loop has a CLI command and real output, not a concept table.
Act
Handoff routing
query --agent · MCP handoff.resolve
Bridge
Human ↔ agent
bootstrap agent-docs · bridge.humanDoc
Learn
Agent memory → docs
memory classify · promote --pr
Explain
Local consult
ask · optional Ollama chat
Used by AgentsKit (public)
Dogfooded on open surfaces — not private monorepo claims.
CI on every PR
Stale handoffs fail the build — same gate locally and in GitHub Actions.
# .github/workflows/pr.yml
- uses: AgentsKit-io/doc-bridge@v1.4.0
with:
config-path: doc-bridge.config.json