mirror of
https://github.com/openclaw/openclaw.git
synced 2026-04-27 09:02:15 +00:00
Docs: add boundary AGENTS guides (#56647)
This commit is contained in:
36
src/plugins/AGENTS.md
Normal file
36
src/plugins/AGENTS.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# Plugins Boundary
|
||||
|
||||
This directory owns plugin discovery, manifest validation, loading, registry
|
||||
assembly, and contract enforcement.
|
||||
|
||||
## Public Contracts
|
||||
|
||||
- Docs:
|
||||
- `docs/plugins/architecture.md`
|
||||
- `docs/plugins/manifest.md`
|
||||
- `docs/plugins/sdk-overview.md`
|
||||
- `docs/plugins/sdk-entrypoints.md`
|
||||
- Definition files:
|
||||
- `src/plugins/types.ts`
|
||||
- `src/plugins/runtime/types.ts`
|
||||
- `src/plugins/contracts/registry.ts`
|
||||
- `src/extensions/public-artifacts.ts`
|
||||
|
||||
## Boundary Rules
|
||||
|
||||
- Preserve manifest-first behavior: discovery, config validation, and setup
|
||||
should work from metadata before plugin runtime executes.
|
||||
- Keep loader behavior aligned with the documented Plugin SDK and manifest
|
||||
contracts. Do not create private backdoors that bundled plugins can use but
|
||||
external plugins cannot.
|
||||
- If a loader or registry change affects plugin authors, update the public SDK,
|
||||
docs, and contract tests instead of relying on incidental internals.
|
||||
- Do not normalize "plugin-owned" into "core-owned" by scattering direct reads
|
||||
of `plugins.entries.<id>.config` through unrelated core paths. Prefer generic
|
||||
helpers, plugin runtime hooks, manifest metadata, and explicit auto-enable
|
||||
wiring.
|
||||
- When plugin-owned tools or provider fallbacks need core participation, keep
|
||||
the contract generic and honor plugin disablement plus SecretRef semantics.
|
||||
- Keep contract loading and contract tests on the dedicated bundled registry
|
||||
path. Do not make contract validation depend on activating providers through
|
||||
unrelated production resolution flows.
|
||||
1
src/plugins/CLAUDE.md
Symbolic link
1
src/plugins/CLAUDE.md
Symbolic link
@@ -0,0 +1 @@
|
||||
AGENTS.md
|
||||
Reference in New Issue
Block a user