AgentsKit Doc Bridge
About
Gives coding agents deterministic, read-only documentation handoffs with edit boundaries, ownership, and required checks before repository changes.
Details
- Author
- agentskit-io
- Categories
- Developer Tools, Knowledge Base, Other
Jump to
Setup
Install AgentsKit Doc Bridge in your MCP client (Claude Desktop, Cursor, Windsurf, and others).
Repository: https://github.com/agentskit-io/doc-bridge
Follow the installation instructions in the repository README, then restart your MCP client.
npm:@agentskit/doc-bridge·CLI:ak-docs·Landing:agentskit-io.github.io/doc-bridge
Topics:ai-agents·documentation·developer-experience·mcp·llms-txt·typescript
Compatibility:node >=22 · TypeScript 5.8+ · pnpm, npm, or yarn consumers
Turn your docs into executable handoffs for coding agents.
doc-bridge reads your repo docs, ownership map, and human documentation site, then gives every agent the same answer:
- where to start reading
- which files/packages it may edit
- which checks prove the change
- which human docs explain the feature
It is not a wiki or hosted RAG. The core workswithout any LLM or API key; the documentation portal dogfoods AgentsKit Chat as an optional surface over that deterministic layer.
Agents are powerful, but most repo docs are written for humans. The result is familiar: the agent guesses ownership, edits the sibling package, runs the wrong test, or ignores the human guide that already explained the rule.
{ "startHere": "docs/for-agents/packages/auth.md", "editRoots": ["packages/auth"], "checks": ["pnpm --filter @demo/auth test"], "humanDoc": "/docs/guides/auth" }
That contract works from the terminal, MCP, CI, and optional RAG/chat.
npm i -D @agentskit/doc-bridge npx ak-docs demo --text
No config, no docs to read first. Output shows before/after, a real handoff, gate red→green, and the MCP snippet:
After (handoff.resolve / query --agent) ✓ target: auth (packages/auth) ✓ start: docs/for-agents/packages/auth.md ✓ edit: packages/auth ✓ checks: pnpm --filter @demo/auth test · pnpm --filter @demo/auth lint ✓ human guide: /docs/guides/auth Gate: red → green
npx ak-docs demo --fixture monorepo --text
This checked example runs the bundled demo through the public CLI. The README gate compares this block byte-for-byte with the executable fixture and runs it on every PR.
import { execFileSync } from 'node:child_process' execFileSync(process.execPath, ['bin/ak-docs.js', 'demo', '--text'], { stdio: 'inherit', })
npx ak-docs init npx ak-docs index npx ak-docs query package example --agent ak-docs mcp install --cursor # wires MCP into .cursor/mcp.json
Using Cline? Follow the deterministicllms-install.mdsetup. It runs the pinned MCP server throughpnpm dlxwithout adding Doc Bridge to your repository dependencies.
Seedocs/getting-started.md,docs/mcp.md, anddocs/examples.md.
This repository also contains a Cursor plugin that pairs the read-only Doc Bridge MCP server with a handoff skill. It resolvesstartHere,readBeforeEditing,editRoots, andchecksbefore Cursor edits a routed repository. The plugin does not request credentials or write project files through MCP.
The root Agent Plugins manifest exposes the same portable handoff skill and read-only MCP server to GitHub Copilot CLI. Copilot discoversskills/and.mcp.jsonfrom the standard plugin layout, so the integration stays source-owned instead of copying prompts into another repository.
copilot plugin install AgentsKit-io/doc-bridge
Install the published skill fromClawHub:
Pi users can install the same source-owned skill through the npm package:
Doc Bridge can be packaged as a local MCP Bundle for Claude Desktop. The bundle keeps the eight MCP tools read-only and asks the user to select the repository'sdoc-bridge.config.json; that file defines the project boundary Doc Bridge may read.
pnpm install --frozen-lockfile pnpm mcpb:pack
The command builds Doc Bridge, creates a production-only staging directory, validates the MCPB manifest, packs the extension, checks its file inventory, and writes the local artifact under.mcpb-output/. Generated bundles and staging directories are intentionally excluded from Git.
Current packaged compatibility is macOS. Other operating systems will be declared only after the exact bundle passes an independent installation test there.
{ "type": "agent-handoff", "startHere": "docs/for-agents/packages/auth.md", "editRoots": ["packages/auth"], "checks": ["pnpm --filter @demo/auth test"], "humanDoc": "/docs/guides/auth", "bridge": { "humanDoc": "linked" } }
When a human guide is missing, handoffs surface it as a feature:
{ "bridge": { "humanDoc": "missing", "action": "ak-docs bootstrap agent-docs" }, "notes": ["Human guide missing for billing. Run: ak-docs bootstrap agent-docs"] }
ak-docs ask "who owns schemas" # Best match: ownership os-core # Handoff preview # start: docs/for-agents/packages/os-core.md # edit: packages/os-core # checks: pnpm --filter os-core lint · pnpm --filter os-core test
ak-docs doctor --text ak-docs doctor --badge # shields.io markdown for README ak-docs index --watch # keep index fresh while editing docs
Score: 82/100 (B) Agent docs: 8/10 (80% handoff-ready) Human guides: 6/10 (60% bridged) Gates: 3/3 passing Next actions → ak-docs bootstrap agent-docs → ak-docs query package billing --agent
- MCP auto-wire:ak-docs mcp install --cursor
- Skill/rule:pastedocs/skills/doc-bridge.mdinto Cursor rules — agents callhandoff.resolvebefore editingpackages/*
- Handoff is the next step:startHere,checks, andbridgeare in the JSON/MCP response
Reuse the bundled GitHub Action on every PR:
permissions: contents: read steps: - uses: actions/checkout@v4 - uses: AgentsKit-io/doc-bridge@v1.4.0 with: config-path: doc-bridge.config.json
The Action checks the committed index before changing anything, pins the matching npm package, and rejects non-exact package versions. See theMarketplace guide.
Runak-docs doctor --badgelocally to refresh — orpnpm coverage:badgein CI.
ak-docs index && ak-docs gate run
Gate fails withIndex is stale. Run: ak-docs index— same check in CI annotations.
npm i -D @agentskit/rag @agentskit/ink @agentskit/adapters @agentskit/memory react ak-docs rag ingest && ak-docs chat
Designed for and dogfooded on open AgentsKit surfaces:
Playbook pattern:docs/playbook/doc-bridge-pattern.md— export withak-docs playbook pattern --text
Contract:docs/spec/config-v1.md· CLI:docs/spec/cli.md· MCP:docs/mcp.md· Skill:docs/skills/doc-bridge.md· Pattern:docs/playbook/doc-bridge-pattern.md· Recipes:docs/recipes/index-pipeline.md
ak-docs memory ingest ak-docs memory classify ak-docs memory promote --pr --dry-run # preview gh commands ak-docs memory promote --pr # opens draft PR via gh
v1.4.0 stable— portable, fail-closed handoffs for Cursor, Pi, Hermes, and ClawHub-compatible clients; deterministic Documentation Standard v1 conformance; verified release provenance; Marketplace Action; doctor + CI + skill; and full Tier A/B/C.
pnpm install && pnpm build && pnpm test pnpm smoke:ollama # optional — skips if Ollama/peers unavailable
Landing:https://doc-bridge.agentskit.io/
The local MCP server reads only the project selected throughdoc-bridge.config.json. It does not require an API key, send project data to AgentsKit, collect telemetry, or write project files through its eight MCP tools. See the completePrivacy Policyfor accessed paths, use, storage, sharing, retention, optional integrations, and contact information.
This is a web browser that enables your coding agent, such as Claude Code, to visit websites on your behalf and assist you in identifying bugs or creating UI test cases.
Extentos is a multi-vendor development platform for adding smart-glasses capabilities to existing iOS and Android apps. The simplest analogy is Stripe for smart glasses
An MCP server tailored for React Native–first development using Gluestack UI
Create and read feature flags, review experiments, generate flag types, search docs, and interact with GrowthBook's feature flagging and experimentation platform.
Gives AI agents public URLs (tunnels) for localhost, live HTTP traffic inspection, snapshot publishing, and access control.
Understand, develop, and debug authorization policies in Oso Cloud.
Up-to-date documentation for your coding agent. Covers 1000s of public repos and sites. Built by ref.tools
Points agents to the canonical Agentry install docs for errors, product analytics, and deploy attribution.
Deterministic JSON checks with signed evidence and x402-paid execution
Search Apple's Developer Documentation with smart search and wildcard support.
Tamper-evident action logging for AI agents: hash-chained ledger_append/ledger_verify MCP tools over one JSONL file, zero dependencies — proves the record wasn't altered in place (limits stated honestly in the docs).
Sign in to leave a review
Use Google, GitHub, or an email account so ratings stay tied to real people.
No reviews posted yet.
