Skip to content

docs(plugins): document plugin contract v2, the inventory and ADR 0034 - #3769

Open
thymikee wants to merge 1 commit into
feat/plugin-registry-v2-statusfrom
feat/plugin-registry-v2-docs
Open

thymikee wants to merge 1 commit into
feat/plugin-registry-v2-statusfrom
feat/plugin-registry-v2-docs

Conversation

@thymikee

@thymikee thymikee commented Oct 16, 2026 •

Copy link
Copy Markdown
Member

Summary

Part 3 of 4 of #3755 (umbrella #3747), stacked on #3768. Blocked by #3748: do not merge before it.

Docs only:

  • website/docs/docs/plugins.md: v2 authoring (./agent-device export, factory with options, setup, credentials with byBackend, connection), entry discovery and the no-fallback rule, the registry order and duplicate rule, daemon status and the inventory entry shape, and a short section on v1 plugins.
  • ADR 0034, "Provider plugin registry" (brief): three sources, one shape, set fixed per daemon, failure isolation, and a short daemon-ownership note pointing to feat(client): explicit daemon lifecycle with ensureDaemon() and attach clients #3754 and feat(host): startAgentDevice() for embedder-owned daemons #3757. Indexed in docs/adr/README.md.
  • CHANGELOG.md entry for the contract, registry, isolation, inventory and daemon status.
  • limrun.md and build-an-integration.md follow the renamed diagnostic and contract.

Runtime tests do not apply to prose; the docs checks in check:affected ran.

Validation

pnpm check:affected --run --head 495046c784 (the stack top, which contains this layer): passed (exactCommit).

🤖 Generated with Claude Code

View guided diff Turn on auto-fix

@github-actions

github-actions Bot commented Oct 16, 2026 •

Copy link
Copy Markdown
Contributor

Size Report

Metric Base Current Diff
Installed (including dependencies) 5.35 MB 5.35 MB 0 B
Package (unpacked) 5.35 MB 5.35 MB 0 B
Package (download) 1.61 MB 1.61 MB -9 B

Startup median (7 runs, lower is better):

Scenario Base Current Diff
CLI --version 17.8 ms 18.2 ms +0.4 ms
CLI --help 49.3 ms 50.3 ms +1.0 ms

@github-actions

github-actions Bot commented Oct 16, 2026 •

Copy link
Copy Markdown
Contributor
PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://callstack.github.io/agent-device/pr-preview/pr-3769/

Built to branch gh-pages at 2026-10-17 05:26 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@cubic-dev-ai cubic-dev-ai Bot left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All reported issues were addressed across 6 files

You’re at about 93% of the monthly reviewed-line limit. You may want to disable incremental reviews to conserve quota. Reviews will continue until that limit is exceeded. If you need help avoiding interruptions, please contact contact@cubic.dev.

Reply with feedback, questions, or to request a fix.

View guided diff | Turn on auto-fix | Re-trigger cubic

Comment thread docs/adr/0034-provider-plugin-registry.md Outdated
Comment thread website/docs/docs/plugins.md Outdated
Comment thread website/docs/docs/plugins.md Outdated
Comment thread website/docs/docs/plugins.md Outdated
Comment thread docs/adr/0034-provider-plugin-registry.md Outdated
Comment thread CHANGELOG.md Outdated
Comment thread website/docs/docs/plugins.md Outdated
Comment thread docs/adr/0034-provider-plugin-registry.md Outdated
@thymikee
thymikee force-pushed the feat/plugin-registry-v2-status branch from 2e08f8f to 8566cee Compare October 16, 2026 23:02
@thymikee
thymikee force-pushed the feat/plugin-registry-v2-docs branch from 190029c to 296826f Compare October 16, 2026 23:02
@thymikee
thymikee force-pushed the feat/plugin-registry-v2-status branch from 8566cee to 5645905 Compare October 16, 2026 23:17
@thymikee
thymikee force-pushed the feat/plugin-registry-v2-docs branch from 296826f to 058826d Compare October 16, 2026 23:17
@thymikee

Copy link
Copy Markdown
Member Author

This PR is ready at 058826d. CI is green, with 14 checks and none failing, and the change is docs-only. No conflicts. Not blocking, take or leave: the Connect section at website/docs/docs/plugins.md#L95 lists resolve({flags,env,cwd,stateDir}) and verify({flags,env}), but the contract in packages/plugins/src/contract.ts also passes host to both callbacks, so the example could add it; and the CHANGELOG.md entry is one long bullet that mixes contract, registry, status, fingerprint and Limrun changes, so a few shorter bullets would read better. I compared the docs against the base branch head (5645905), not a checkout of this PR head. I did not run the docs build, trace the registry ordering or the plugins list inventory behavior into code, or check the ADR header format against ADRs 0001-0033. Nothing else stands in the way; the stack merges in order (#3767, #3768, then this PR).

@thymikee thymikee added the ready-for-human Valid work that needs human implementation, judgment, or maintainer merge label Oct 17, 2026
@thymikee
thymikee force-pushed the feat/plugin-registry-v2-status branch from 5645905 to 8e5814d Compare October 17, 2026 05:06
@thymikee
thymikee force-pushed the feat/plugin-registry-v2-docs branch from 058826d to 5c46bf5 Compare October 17, 2026 05:06
@thymikee

Copy link
Copy Markdown
Member Author

Thanks. Taken in 5c46bf5: the Connect example now passes host to resolve and verify, with a sentence saying it is the same ProviderPluginHost that setup gets, and the CHANGELOG entry is split into five bullets (contract, registry, failure isolation and status, client fingerprint and Limrun fingerprint, partial-Limrun diagnostic).

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@thymikee
thymikee force-pushed the feat/plugin-registry-v2-status branch from 8e5814d to e886ff7 Compare October 17, 2026 05:23
@thymikee
thymikee force-pushed the feat/plugin-registry-v2-docs branch from 5c46bf5 to f93a0a0 Compare October 17, 2026 05:23

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready-for-human Valid work that needs human implementation, judgment, or maintainer merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant