Gustavo Madeira Santana
e5dac0c39e
CLI: keep root help plugin descriptors non-activating ( #57294 )
...
Merged via squash.
Prepared head SHA: c8da48f689
Co-authored-by: gumadeiras <5599352+gumadeiras@users.noreply.github.com >
Co-authored-by: gumadeiras <5599352+gumadeiras@users.noreply.github.com >
Reviewed-by: @gumadeiras
2026-03-29 18:49:57 -04:00
Peter Steinberger
35233bae96
refactor: decouple bundled plugin sdk surfaces
2026-03-29 21:20:46 +01:00
Gustavo Madeira Santana
9b4f26e70a
Plugins/CLI: add descriptor-backed lazy root command registration ( #57165 )
...
Merged via squash.
Prepared head SHA: ad1dee32eb
Co-authored-by: gumadeiras <5599352+gumadeiras@users.noreply.github.com >
Co-authored-by: gumadeiras <5599352+gumadeiras@users.noreply.github.com >
Reviewed-by: @gumadeiras
2026-03-29 16:02:59 -04:00
Peter Steinberger
82f04ced27
refactor(plugin-sdk): drop legacy provider compat subpaths
2026-03-29 20:55:53 +01:00
George Zhang
9ea0b76f06
docs(plugins): document before_install hook
2026-03-29 12:35:01 -07:00
Peter Steinberger
922c90e9fa
refactor: add approval runtime sdk seam
2026-03-28 06:33:07 +00:00
Peter Steinberger
0d98ce1065
refactor: add diagnostic and error runtime sdk seams
2026-03-28 06:26:38 +00:00
Peter Steinberger
70c2458861
refactor: add host and collection runtime sdk seams
2026-03-28 06:19:16 +00:00
Peter Steinberger
c222a44e6f
refactor: add retry runtime sdk seam
2026-03-28 05:59:07 +00:00
Peter Steinberger
a126d23f0d
refactor: add fetch runtime sdk seam
2026-03-28 05:44:33 +00:00
Peter Steinberger
838013c87a
refactor: expose webhook request guard sdk seam
2026-03-28 05:17:19 +00:00
Peter Steinberger
b9560f4685
docs: clarify legacy provider sdk compat barrels
2026-03-28 01:12:52 +00:00
Peter Steinberger
b8069c2bd1
refactor: trim provider model compat seams
2026-03-28 00:17:28 +00:00
Peter Steinberger
dd640e3c41
refactor: add focused global singleton sdk seam
2026-03-28 00:05:32 +00:00
Peter Steinberger
0b26e4d72a
refactor: split shared provider catalog sdk helpers
2026-03-27 23:55:10 +00:00
Peter Steinberger
e951838c33
docs: point sdk overview at provider model shared seam
2026-03-27 23:50:04 +00:00
Peter Steinberger
c9556c257e
docs: clarify memory plugin adapter ids
2026-03-27 00:47:01 +00:00
Peter Steinberger
e0dfc776bb
refactor: move memory flush ownership into memory plugin
2026-03-26 22:00:13 +00:00
Peter Steinberger
a4a00aa1da
feat: pluginize cli inference backends
2026-03-26 15:11:15 +00:00
Josh Avant
10161c2d79
Plugins: enforce terminal hook decision semantics for tool/message guards ( #54241 )
...
* Plugins: enforce terminal hook decision policies
* Tests: assert terminal hook behavior in integration paths
* Docs: clarify terminal hook decision semantics
* Docs: add hook guard semantics to plugin guides
* Tests: isolate outbound format label expectations
* changelog
Signed-off-by: joshavant <830519+joshavant@users.noreply.github.com >
---------
Signed-off-by: joshavant <830519+joshavant@users.noreply.github.com >
2026-03-25 00:11:13 -05:00
Vincent Koc
3fe2f0a550
docs: fix CLI command tree, SDK import path, and tool group listing
...
- Remove non-existent 'secrets migrate' from CLI command tree
- Add actual secrets subcommands: audit, configure, apply
- Add missing plugin subcommands: inspect, uninstall, update, marketplace list
- Fix plugins info -> inspect (actual command name)
- Add message send and broadcast subcommands to command tree
- Remove misleading deprecated import from sdk-overview
- Add sessions_yield and subagents to group:sessions tool group docs
- Fix formatting
2026-03-23 10:40:41 -07:00
Vincent Koc
05055e200a
fix(docs): remaining code audit fixes
...
- sdk-entrypoints.md: fix mislabeled 'Channel entry options' heading
(should be 'Options' — these are definePluginEntry options, not
channel-specific)
- sdk-overview.md: add 4 missing API object fields (version, description,
source, rootDir) from OpenClawPluginApi type
2026-03-22 18:59:03 -07:00
Vincent Koc
28838802d4
docs(plugins): add SDK reference and how-to guide pages ( #52366 )
...
* docs(plugins): add SDK reference and how-to guide pages
Create 7 new plugin SDK documentation pages:
- sdk-overview: import map, registration API reference
- sdk-entrypoints: definePluginEntry/defineChannelPluginEntry reference
- sdk-runtime: api.runtime namespace reference
- sdk-setup: packaging, manifests, config schemas reference
- sdk-channel-plugins: step-by-step channel plugin how-to
- sdk-provider-plugins: step-by-step provider plugin how-to
- sdk-testing: test utilities and patterns reference
Restructure plugin docs navigation with nested groups:
- Top-level: user-facing pages (Install, Community, Bundles)
- Building Plugins: Getting Started, Channel, Provider
- SDK Reference: Overview, Entry Points, Runtime, Setup, Testing, Migration, Manifest, Internals
Revise existing pages for new IA:
- building-plugins.md: tightened as quick-start, routes to detailed guides
- architecture.md: updated info box with links to new guides
- sdk-migration.md: expanded Related section
* docs(plugins): add Mintlify components (Steps, CodeGroup, Tabs, Accordion, CardGroup)
- Channel plugin guide: wrap walkthrough in Steps, use CodeGroup for
package.json/manifest, Accordion for createChatChannelPlugin details,
CardGroup for advanced topics
- Provider plugin guide: wrap walkthrough in Steps, use CodeGroup for
package files, Tabs for hook examples, Accordion for all-hooks reference
- Getting started: use CardGroup for plugin-type picker and next steps,
CodeGroup for package/manifest
- SDK Overview: wrap subpath tables in AccordionGroup for scannability
* fix(docs): address PR review feedback on plugin SDK pages
- Remove nonexistent api.runtime.channel.handleInboundMessage call,
replace with realistic webhook pattern and note about channel-specific
inbound handling (issue a)
- Fix registrationMode values: 'setup' -> 'setup-only' and 'setup-runtime'
matching actual PluginRegistrationMode type (issue b)
- Fix createOptionalChannelSetupSurface params: channelId -> channel,
add required label field (issue c)
- Fix broken anchor links: #multi-capability-providers ->
#step-5-add-extra-capabilities, #plugin-kinds -> #registration-api (issue d)
- Add missing acmeChatApi import in channel plugin example (issue e)
- Fix undefined provider variable in provider test example (issue f)
* fix(docs): use correct createProviderApiKeyAuthMethod options
Replace incorrect params (provider, validate) with actual required fields
(providerId, methodId, optionKey, flagName, promptMessage) matching
src/plugins/provider-api-key-auth.ts.
* fix(docs): address second round of PR review feedback
- Add required model fields (reasoning, input, cost, contextWindow,
maxTokens) to catalog example (issue b)
- Fix buildChannelConfigSchema to take a Zod schema argument (issue c)
- Replace fabricated setupWizard steps/run with real ChannelSetupWizard
contract (channel, status, credentials) (issue d)
- Add required sessionFile/workspaceDir to runEmbeddedPiAgent (issue e)
- Fix wrapStreamFn to return StreamFn from ctx.streamFn (issue f)
2026-03-22 11:35:53 -07:00
Peter Steinberger
05279539a8
docs(plugin-sdk): document public SDK surface
2026-03-22 08:50:48 -07:00