@agentskit/doc-bridge 1.2.4 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. package/CHANGELOG.md +21 -0
  2. package/CONTRIBUTING.md +6 -0
  3. package/PRIVACY.md +38 -0
  4. package/README.md +30 -3
  5. package/SECURITY.md +7 -2
  6. package/action.yml +1 -1
  7. package/dist/cli/program.js +400 -156
  8. package/dist/cli/program.js.map +1 -1
  9. package/dist/config/index.d.ts +1 -1
  10. package/dist/config/index.js +3 -1
  11. package/dist/config/index.js.map +1 -1
  12. package/dist/{index-DGI9TBLE.d.ts → index-DAeq_OIi.d.ts} +22 -22
  13. package/dist/index.d.ts +47 -12
  14. package/dist/index.js +376 -131
  15. package/dist/index.js.map +1 -1
  16. package/docs/POSITIONING.md +1 -1
  17. package/docs/examples.md +4 -0
  18. package/docs/getting-started.md +1 -1
  19. package/docs/landing/index.html +1 -1
  20. package/docs/mcp.md +16 -0
  21. package/docs/qa/vitepress-starlight-adapters.md +19 -0
  22. package/docs/spec/config-v1.md +33 -2
  23. package/examples/nextra-only.config.ts +17 -0
  24. package/examples/nx-monorepo.config.ts +11 -0
  25. package/examples/starlight-only.config.ts +17 -0
  26. package/examples/vitepress-only.config.ts +19 -0
  27. package/mcpb/.mcpbignore +8 -0
  28. package/mcpb/icon.png +0 -0
  29. package/mcpb/manifest.json +96 -0
  30. package/package.json +14 -11
  31. package/src/config/schema.ts +3 -1
  32. package/src/index-builder/build-handoffs.ts +2 -0
  33. package/src/index-builder/build-index.ts +7 -1
  34. package/src/index-builder/human-adapters/index.ts +6 -0
  35. package/src/index-builder/human-adapters/nextra.ts +43 -0
  36. package/src/index-builder/human-adapters/starlight.ts +40 -0
  37. package/src/index-builder/human-adapters/vitepress.ts +43 -0
  38. package/src/index-builder/plugins/nx.ts +161 -0
  39. package/src/index-builder/plugins/pnpm-monorepo.ts +1 -0
  40. package/src/index-builder/watch-index.ts +11 -2
  41. package/src/index.ts +1 -0
  42. package/src/mcp/server.ts +58 -26
  43. package/src/version.ts +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,25 @@
1
1
  # Changelog
2
2
 
3
+ ## 1.3.0
4
+
5
+ ### Minor Changes
6
+
7
+ - 319605e: Add read-only Nx project inference for Doc Bridge ownership, handoffs, and available test and lint checks.
8
+ - e0db193: Add first-party VitePress and Astro Starlight human-documentation adapters.
9
+ - 03c17bc: Add a first-party Nextra human-documentation adapter for deterministic content-directory routes.
10
+
11
+ ## 1.2.6
12
+
13
+ ### Patch Changes
14
+
15
+ - Restore the stable release security gate with patched Next.js and Sharp versions and pnpm 11-compatible dependency overrides.
16
+
17
+ ## 1.2.5
18
+
19
+ ### Patch Changes
20
+
21
+ - d2429f4: Add read-only MCP tool annotations, a public privacy policy, and deterministic MCPB packaging for local Claude Desktop installation.
22
+
3
23
  ## 1.2.4
4
24
 
5
25
  ### Patch Changes
@@ -34,6 +54,7 @@
34
54
 
35
55
  ### Features
36
56
 
57
+ - Add read-only MCP tool annotations, a public privacy policy, and validated MCPB packaging for local Claude Desktop installation.
37
58
  - Migrate the documentation portal dogfood from AgentsKit Chat 0.2 packages (`@agentskit/chat-protocol`, `@agentskit/chat-react`) to the consolidated 0.3.x surface (`@agentskit/chat/protocol`, `@agentskit/chat/react`) while keeping `@agentskit/chat` as the root package.
38
59
  - Replace the legacy Pages landing with a statically exported Fumadocs portal backed directly by the canonical `docs/**` corpus.
39
60
  - Generate `llms.txt`, `llms-full.txt`, raw Markdown, and a hash-verified deterministic AgentsKit Chat artifact from the repository's own Doc Bridge index.
package/CONTRIBUTING.md CHANGED
@@ -19,6 +19,7 @@ pnpm build
19
19
  - Add or update the smallest test that would fail if the behavior regresses.
20
20
  - Public contract changes must update the relevant docs under `docs/spec/` or `docs/schemas/`.
21
21
  - Dogfood AgentsKit Chat 0.4.x only: `@agentskit/chat`, `@agentskit/chat/protocol`, and `@agentskit/chat/react`. Never reintroduce `@agentskit/chat-protocol` or `@agentskit/chat-react` (`pnpm check:no-legacy-chat-imports`).
22
+ - Never commit API keys, tokens, secrets, or private repository content.
22
23
 
23
24
  ## Pull request checklist
24
25
 
@@ -38,3 +39,8 @@ pnpm release
38
39
  ```
39
40
 
40
41
  Do not publish from a dirty worktree.
42
+
43
+ Project decisions and maintainer responsibilities are documented in
44
+ [GOVERNANCE.md](GOVERNANCE.md). By participating, you agree to follow the
45
+ [Code of Conduct](CODE_OF_CONDUCT.md). Report vulnerabilities through the
46
+ private process in [SECURITY.md](SECURITY.md).
package/PRIVACY.md ADDED
@@ -0,0 +1,38 @@
1
+ # Privacy Policy
2
+
3
+ Effective date: July 31, 2026
4
+
5
+ This policy covers the local Doc Bridge MCP server distributed by AgentsKit, including its MCP Bundle for Claude Desktop.
6
+
7
+ ## Data the connector accesses
8
+
9
+ Doc Bridge accesses only the local project selected by the user through its `doc-bridge.config.json` file. Within that project, its MCP tools may read:
10
+
11
+ - the Doc Bridge configuration and deterministic index;
12
+ - documentation files explicitly included in that index;
13
+ - ownership and package metadata described by the configuration;
14
+ - `.agent-memory/**` and `.cursor/rules/*.mdc` when the user calls a memory-classification or draft-promotion tool.
15
+
16
+ Doc Bridge does not read Claude conversation history, Claude memory, browser data, credentials, or files outside the selected project boundary. Indexed-document reads reject paths and symbolic links that resolve outside that boundary.
17
+
18
+ ## Collection, use, and storage
19
+
20
+ The local MCP server uses project data only to return the handoff, search, documentation, gate, retrieval, memory-classification, draft, or topology result requested by the user. The eight MCP tools are read-only and do not modify project files or publish data.
21
+
22
+ AgentsKit does not collect or store MCP requests, tool results, project files, or usage telemetry. Source files and any existing Doc Bridge index remain on the user's device and under the user's control.
23
+
24
+ ## Sharing and external services
25
+
26
+ The local MCP server does not send project data to AgentsKit or another model provider and requires no API key. Claude Desktop receives tool results as the MCP client selected by the user; Anthropic's handling of data in Claude Desktop is governed by Anthropic's own terms and privacy policy.
27
+
28
+ Optional Doc Bridge RAG and chat integrations are not enabled or bundled by this local connector. If a user separately configures an external adapter or model provider, that provider's privacy terms apply to the data the user chooses to send through that separate integration.
29
+
30
+ ## Retention and deletion
31
+
32
+ AgentsKit retains no data from the local MCP server. Users control retention by managing their project files, Doc Bridge index, MCP client history, and installed MCP Bundle. Uninstalling the bundle removes the connector; deleting local project data remains the user's responsibility.
33
+
34
+ ## Contact
35
+
36
+ Questions about this policy can be filed at https://github.com/AgentsKit-io/doc-bridge/issues. Security concerns should follow the private reporting process at https://github.com/AgentsKit-io/doc-bridge/security/policy.
37
+
38
+ Material changes to this policy will be published in this repository with an updated effective date.
package/README.md CHANGED
@@ -3,6 +3,7 @@
3
3
  [![npm](https://img.shields.io/npm/v/@agentskit/doc-bridge?style=flat-square)](https://www.npmjs.com/package/@agentskit/doc-bridge)
4
4
  [![CI](https://img.shields.io/github/actions/workflow/status/AgentsKit-io/doc-bridge/ci.yml?branch=master&style=flat-square)](https://github.com/AgentsKit-io/doc-bridge/actions/workflows/ci.yml)
5
5
  [![Pages](https://img.shields.io/github/actions/workflow/status/AgentsKit-io/doc-bridge/pages.yml?branch=master&label=pages&style=flat-square)](https://doc-bridge.agentskit.io/)
6
+ [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/13872/baseline)](https://www.bestpractices.dev/projects/13872)
6
7
  [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](LICENSE)
7
8
  [![Node](https://img.shields.io/badge/node-%3E%3D22-339933?style=flat-square)](package.json)
8
9
  [![TypeScript](https://img.shields.io/badge/types-TypeScript-3178c6?style=flat-square)](dist/index.d.ts)
@@ -105,6 +106,8 @@ npx ak-docs query package example --agent
105
106
  ak-docs mcp install --cursor # wires MCP into .cursor/mcp.json
106
107
  ```
107
108
 
109
+ Using Cline? Follow the deterministic [`llms-install.md`](llms-install.md) setup. It runs the pinned MCP server through `pnpm dlx` without adding Doc Bridge to your repository dependencies.
110
+
108
111
  ## What ships
109
112
 
110
113
  ![doc-bridge index used through CLI, MCP, CI, and documentation adapters](docs/landing/assets/doc-bridge-surfaces.webp)
@@ -115,13 +118,28 @@ ak-docs mcp install --cursor # wires MCP into .cursor/mcp.json
115
118
  | **MCP server** | Let Cursor, Claude Code, Codex-style agents resolve handoffs before editing | `ak-docs mcp`, `handoff.resolve` |
116
119
  | **GitHub Action / CI** | Fail stale indexes and broken human-doc links on PRs | `AgentsKit-io/doc-bridge@v1.2.1` |
117
120
  | **Documentation conformance** | Check the stable ecosystem standard with auditable evidence | `ak-docs conformance run documentation-standard-v1 --text` |
118
- | **Doc adapters** | Link human docs to agent docs | `fumadocs`, `docusaurus`, `plain-markdown` |
119
- | **Monorepo routing** | Discover workspaces and checks | `pnpm-monorepo` |
121
+ | **Doc adapters** | Link human docs to agent docs | `fumadocs`, `docusaurus`, `vitepress`, `starlight`, `nextra`, `plain-markdown` |
122
+ | **Monorepo routing** | Discover workspaces and checks | `pnpm-monorepo`, `nx` |
120
123
  | **Memory pipeline** | Turn agent notes into reviewable documentation drafts | `memory ingest`, `classify`, `promote --pr` |
121
124
  | **Optional RAG/chat** | Ground chat in the same handoff-first index | `@agentskit/rag`, `@agentskit/ink`, `ak-docs chat` |
122
125
 
123
126
  See [docs/getting-started.md](docs/getting-started.md), [docs/mcp.md](docs/mcp.md), and [docs/examples.md](docs/examples.md).
124
127
 
128
+ ## Claude Desktop MCP Bundle
129
+
130
+ 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's `doc-bridge.config.json`; that file defines the project boundary Doc Bridge may read.
131
+
132
+ From a clean checkout:
133
+
134
+ ```bash
135
+ pnpm install --frozen-lockfile
136
+ pnpm mcpb:pack
137
+ ```
138
+
139
+ 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.
140
+
141
+ Current packaged compatibility is macOS. Other operating systems will be declared only after the exact bundle passes an independent installation test there.
142
+
125
143
  ## Why this exists
126
144
 
127
145
  | Pattern | Gap |
@@ -239,7 +257,7 @@ Gate fails with `Index is stale. Run: ak-docs index` — same check in CI annota
239
257
  | **CLI** | `query` / `search` / `list` / `ask` / `gate` / `memory` / `bootstrap` |
240
258
  | **MCP** | `handoff.resolve`, `doc.search`, `doc.get`, `gate.status`, … |
241
259
  | **Gates** | Freshness, human-link validation, optional OKF style |
242
- | **Adapters** | `pnpm-monorepo`, `fumadocs`, `docusaurus`, `plain-markdown` |
260
+ | **Adapters** | `pnpm-monorepo`, `nx`, `fumadocs`, `docusaurus`, `vitepress`, `starlight`, `nextra`, `plain-markdown` |
243
261
 
244
262
  ### Optional AgentsKit peers
245
263
 
@@ -274,8 +292,12 @@ Designed for and dogfooded on open AgentsKit surfaces:
274
292
  |---------|---------|
275
293
  | Solo markdown | [`examples/minimal-plain-markdown.config.ts`](examples/minimal-plain-markdown.config.ts) |
276
294
  | pnpm monorepo | [`examples/pnpm-monorepo.config.ts`](examples/pnpm-monorepo.config.ts) |
295
+ | Nx monorepo | [`examples/nx-monorepo.config.ts`](examples/nx-monorepo.config.ts) |
277
296
  | Demo monorepo | [`examples/demo-monorepo/`](examples/demo-monorepo/) |
278
297
  | Fumadocs + chat | [`examples/fumadocs-with-chat.config.ts`](examples/fumadocs-with-chat.config.ts) |
298
+ | VitePress | [`examples/vitepress-only.config.ts`](examples/vitepress-only.config.ts) |
299
+ | Astro Starlight | [`examples/starlight-only.config.ts`](examples/starlight-only.config.ts) |
300
+ | Nextra | [`examples/nextra-only.config.ts`](examples/nextra-only.config.ts) |
279
301
 
280
302
  Contract: [`docs/spec/config-v1.md`](docs/spec/config-v1.md) · CLI: [`docs/spec/cli.md`](docs/spec/cli.md) · MCP: [`docs/mcp.md`](docs/mcp.md) · Skill: [`docs/skills/doc-bridge.md`](docs/skills/doc-bridge.md) · Pattern: [`docs/playbook/doc-bridge-pattern.md`](docs/playbook/doc-bridge-pattern.md) · Recipes: [`docs/recipes/index-pipeline.md`](docs/recipes/index-pipeline.md)
281
303
 
@@ -299,6 +321,10 @@ pnpm smoke:ollama # optional — skips if Ollama/peers unavailable
299
321
 
300
322
  **Landing:** https://doc-bridge.agentskit.io/
301
323
 
324
+ ## Privacy Policy
325
+
326
+ The local MCP server reads only the project selected through `doc-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 complete [Privacy Policy](PRIVACY.md) for accessed paths, use, storage, sharing, retention, optional integrations, and contact information.
327
+
302
328
  ## Contributing
303
329
 
304
330
  Issues and PRs are welcome. Start here:
@@ -306,6 +332,7 @@ Issues and PRs are welcome. Start here:
306
332
  | Need | Doc |
307
333
  |------|-----|
308
334
  | Local setup, tests, release flow | [CONTRIBUTING.md](CONTRIBUTING.md) |
335
+ | Governance and maintainer responsibilities | [GOVERNANCE.md](GOVERNANCE.md) |
309
336
  | Vulnerability reports | [SECURITY.md](SECURITY.md) |
310
337
  | Community standards | [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) |
311
338
  | Release history | [CHANGELOG.md](CHANGELOG.md) |
package/SECURITY.md CHANGED
@@ -8,14 +8,19 @@ Security fixes target the latest stable `@agentskit/doc-bridge` release on npm.
8
8
 
9
9
  Please do not open a public issue for security reports.
10
10
 
11
- Email security reports to `security@agentskit.io` with:
11
+ Use [GitHub private vulnerability reporting](https://github.com/AgentsKit-io/doc-bridge/security/advisories/new) when possible. If that channel is unavailable, email `security@agentskit.io`.
12
+
13
+ Include:
12
14
 
13
15
  - affected version or commit
14
16
  - reproduction steps
15
17
  - impact
16
18
  - any suggested fix
17
19
 
18
- We will acknowledge reports as soon as practical and coordinate disclosure before publishing details.
20
+ Please do not include secrets or private repository content beyond what is
21
+ necessary to reproduce the issue. We aim to acknowledge a complete report
22
+ within 14 days, investigate it, and coordinate disclosure and remediation with
23
+ the reporter before publishing details.
19
24
 
20
25
  ## Security expectations
21
26
 
package/action.yml CHANGED
@@ -20,7 +20,7 @@ inputs:
20
20
  package-version:
21
21
  description: Exact @agentskit/doc-bridge npm version (kept in sync with this Action release)
22
22
  required: false
23
- default: '1.2.4'
23
+ default: '1.3.0'
24
24
 
25
25
  runs:
26
26
  using: composite