mirror of
https://github.com/openclaw/openclaw.git
synced 2026-06-01 21:35:53 +00:00
* refactor: extract agent core package Introduce packages/agent-core as the OpenClaw-owned home for reusable agent loop, harness, session, prompt, and runtime dependency contracts. * refactor: extract shared llm runtime Move provider model registries, stream wrappers, OAuth helpers, and LLM utilities into src/llm with plugin-sdk barrels instead of depending on the old embedded runtime layout. * refactor: remove pi runtime internals Rename remaining Pi-shaped agent surfaces to OpenClaw agent runtime names, delete obsolete Pi docs and package graph checks, and add the third-party notice for incorporated code. * refactor: tighten agent session runtime Make agent-core/runtime dependencies explicit, consolidate compaction and session transcript helpers, and move model/session helpers behind OpenClaw-owned contracts. * refactor: remove static model and pi auth paths Drop static model catalogs and Pi auth bridges, move model/provider facts to manifest-owned runtime contracts, and harden internal embedded-agent utilities. * refactor: remove legacy provider compat paths * docs: remove agent parity notes * fix: skip provider wildcard metadata parsing * refactor: share session extension sdk loading * refactor: inline acpx proxy error formatter * refactor: fold edit recovery into edit tool * fix: accept extension batch separator * test: align startup provider plugin expectations * fix: restore provider-scoped release discovery * test: align static asset packaging expectations * fix: run static provider catalogs during scoped discovery * fix: add provider entry catalogs for scoped live discovery * fix: load lightweight provider catalog entries * fix: refresh provider-scoped plugin metadata * fix: keep provider catalog entries on release live path * fix: keep static manifest models in release live checks * fix: harden release model discovery * fix: reduce OpenAI live cache probe reasoning * fix: disable OpenAI cache probe reasoning * ci: extend OpenAI gateway live timeout * fix: extend live gateway model budget * fix: stabilize release validation regressions * fix: honor provider aliases in model rows * fix: stabilize release validation lanes * fix: stabilize release memory qa * ci: stabilize release validation lanes * ci: prefer ipv4 for live docker node calls * fix: restore shared tool-call stream wrapper * ci: remove legacy pi test shard alias * fix: clean up embedded agent test drift * fix: stabilize runtime alias status * fix: clean up embedded agent ci drift * fix: restore release ci invariants * fix: clean up post-rebase runtime drift * fix: restore release ci checks * fix: restore release ci after rebase * fix: remove stale pi runtime path * test: align compaction runtime expectations * test: update plugin prerelease expectations * fix: handle claude live tool approvals * fix: stabilize release validation gates * fix: finish agent runtime import * test: finish post-rebase agent runtime mocks * fix: keep codex compaction native * fix: stabilize codex app-server hook tests * test: isolate codex diagnostic active run * test: remove codex diagnostic completion race # Conflicts: # extensions/codex/src/app-server/run-attempt.test.ts * ci: fix full release manifest performance run id * refactor: narrow llm plugin sdk boundary * chore: drop generated google boundary stamps * fix: repair rebase fallout * fix: clean up rebased runtime references * fix: decode codex jwt payloads as base64url * fix: preserve shipped pi runtime alias * fix: add scoped sdk virtual modules * fix: decode llm codex oauth jwt as base64url * fix: avoid stale vertex adc negative cache * fix: harden tool arg decoding and codeql path * fix: keep vertex adc negative checks live * refactor: consolidate codex jwt and edit helpers * fix: await codex oauth node runtime imports * fix: preserve sdk tool and notice contracts * fix: preserve shipped compat config boundaries * fix: align codex oauth callback host * fix: terminate agent-core loop streams on failure * fix: keep codex oauth callback alive during fallback * ci: include session tools in critical codeql scans * fix: keep Cloudflare Anthropic provider auth header * docs: redirect legacy pi runtime pages * fix: honor bundled web provider compat discovery * fix: protect session output spill files * fix: keep legacy agent dir env blocked * fix: contain auto-discovered skill symlinks * fix: harden agent core sdk proxy surfaces * fix: restore approval reaction sdk compat * fix: keep live docker runs bounded * fix: keep codex oauth redirect host aligned * fix: resolve post-rebase agent runtime drift * fix: redact anthropic oauth parse failures * fix: preserve responses strict tool shaping * fix: repair agent runtime rebase cleanup * docs: redirect retired parity pages * fix: bound auto-discovered resources to roots * fix: repair post-rebase agent test drift * fix: preserve bundled provider allowlist migration * fix: preserve manifest-owned provider aliases * fix: declare photon image dependency * fix: keep provider headers out of proxy body * fix: preserve shipped env aliases * fix: refresh control ui i18n generated state * fix: quote read fallback paths * fix: preview edits through configured backend * test: satisfy core test typecheck * fix: preserve ZAI usage auth fallback * test: repair codex diagnostic test * fix: repair agent runtime rebase drift * test: finish embedded runner import rename * fix: repair agent runtime rebase integrations * test: align compaction oauth fallback expectations * fix: allow sdk-auth session models * fix: update doctor tool schema import * fix: preserve bedrock plugin region * fix: stream harmony-like prose immediately * ci: include session runtime in codeql shards * fix: repair latest rebase integrations * fix: honor explicit codex websocket transport * fix: keep openai-compatible credentials provider-scoped * fix: refresh sdk api baseline after rebase * fix: route cli runtime aliases through openclaw harness * test: rename stale harness mock expectation * test: rename embedded agent overflow calls * test: clean embedded auth test wording * test: use openclaw stream types in deepinfra cache test * fix: refresh sdk api baseline on latest main * fix: honor bundled discovery compat allowlists * fix: refresh sdk api baseline after latest rebase * fix: remove stale rebase imports * test: rename stale model catalog mock * test: mock renamed doctor runtime modules * fix: map canonical kimi env auth * fix: use internal model registry in bench script * fix: migrate deepinfra provider catalog entry * fix: enforce builtin tool suppression * fix: route compaction auth and proxy payloads safely * refactor: prune unused llm registry leftovers * test: update codex hooks session import * test: fix model picker ci coverage * test: align model picker auth mock types
311 lines
12 KiB
Markdown
311 lines
12 KiB
Markdown
---
|
|
summary: "Install and use Codex, Claude, and Cursor bundles as OpenClaw plugins"
|
|
read_when:
|
|
- You want to install a Codex, Claude, or Cursor-compatible bundle
|
|
- You need to understand how OpenClaw maps bundle content into native features
|
|
- You are debugging bundle detection or missing capabilities
|
|
title: "Plugin bundles"
|
|
---
|
|
|
|
OpenClaw can install plugins from three external ecosystems: **Codex**, **Claude**,
|
|
and **Cursor**. These are called **bundles** — content and metadata packs that
|
|
OpenClaw maps into native features like skills, hooks, and MCP tools.
|
|
|
|
<Info>
|
|
Bundles are **not** the same as native OpenClaw plugins. Native plugins run
|
|
in-process and can register any capability. Bundles are content packs with
|
|
selective feature mapping and a narrower trust boundary.
|
|
</Info>
|
|
|
|
## Why bundles exist
|
|
|
|
Many useful plugins are published in Codex, Claude, or Cursor format. Instead
|
|
of requiring authors to rewrite them as native OpenClaw plugins, OpenClaw
|
|
detects these formats and maps their supported content into the native feature
|
|
set. This means you can install a Claude command pack or a Codex skill bundle
|
|
and use it immediately.
|
|
|
|
## Install a bundle
|
|
|
|
<Steps>
|
|
<Step title="Install from a directory, archive, or marketplace">
|
|
```bash
|
|
# Local directory
|
|
openclaw plugins install ./my-bundle
|
|
|
|
# Archive
|
|
openclaw plugins install ./my-bundle.tgz
|
|
|
|
# Claude marketplace
|
|
openclaw plugins marketplace list <marketplace-name>
|
|
openclaw plugins install <plugin-name>@<marketplace-name>
|
|
```
|
|
|
|
</Step>
|
|
|
|
<Step title="Verify detection">
|
|
```bash
|
|
openclaw plugins list
|
|
openclaw plugins inspect <id>
|
|
```
|
|
|
|
Bundles show as `Format: bundle` with a subtype of `codex`, `claude`, or `cursor`.
|
|
|
|
</Step>
|
|
|
|
<Step title="Restart and use">
|
|
```bash
|
|
openclaw gateway restart
|
|
```
|
|
|
|
Mapped features (skills, hooks, MCP tools, LSP defaults) are available in the next session.
|
|
|
|
</Step>
|
|
</Steps>
|
|
|
|
## What OpenClaw maps from bundles
|
|
|
|
Not every bundle feature runs in OpenClaw today. Here is what works and what
|
|
is detected but not yet wired.
|
|
|
|
### Supported now
|
|
|
|
| Feature | How it maps | Applies to |
|
|
| ------------- | ------------------------------------------------------------------------------------------------- | -------------- |
|
|
| Skill content | Bundle skill roots load as normal OpenClaw skills | All formats |
|
|
| Commands | `commands/` and `.cursor/commands/` treated as skill roots | Claude, Cursor |
|
|
| Hook packs | OpenClaw-style `HOOK.md` + `handler.ts` layouts | Codex |
|
|
| MCP tools | Bundle MCP config merged into embedded OpenClaw settings; supported stdio and HTTP servers loaded | All formats |
|
|
| LSP servers | Claude `.lsp.json` and manifest-declared `lspServers` merged into embedded OpenClaw LSP defaults | Claude |
|
|
| Settings | Claude `settings.json` imported as embedded OpenClaw defaults | Claude |
|
|
|
|
#### Skill content
|
|
|
|
- bundle skill roots load as normal OpenClaw skill roots
|
|
- Claude `commands` roots are treated as additional skill roots
|
|
- Cursor `.cursor/commands` roots are treated as additional skill roots
|
|
|
|
This means Claude markdown command files work through the normal OpenClaw skill
|
|
loader. Cursor command markdown works through the same path.
|
|
|
|
#### Hook packs
|
|
|
|
- bundle hook roots work **only** when they use the normal OpenClaw hook-pack
|
|
layout. Today this is primarily the Codex-compatible case:
|
|
- `HOOK.md`
|
|
- `handler.ts` or `handler.js`
|
|
|
|
#### MCP for embedded OpenClaw
|
|
|
|
- enabled bundles can contribute MCP server config
|
|
- OpenClaw merges bundle MCP config into the effective embedded OpenClaw settings as
|
|
`mcpServers`
|
|
- OpenClaw exposes supported bundle MCP tools during embedded OpenClaw agent turns by
|
|
launching stdio servers or connecting to HTTP servers
|
|
- the `coding` and `messaging` tool profiles include bundle MCP tools by
|
|
default; use `tools.deny: ["bundle-mcp"]` to opt out for an agent or gateway
|
|
- project-local embedded agent settings still apply after bundle defaults, so workspace
|
|
settings can override bundle MCP entries when needed
|
|
- bundle MCP tool catalogs are sorted deterministically before registration, so
|
|
upstream `listTools()` order changes do not thrash prompt-cache tool blocks
|
|
|
|
##### Transports
|
|
|
|
MCP servers can use stdio or HTTP transport:
|
|
|
|
**Stdio** launches a child process:
|
|
|
|
```json
|
|
{
|
|
"mcp": {
|
|
"servers": {
|
|
"my-server": {
|
|
"command": "node",
|
|
"args": ["server.js"],
|
|
"env": { "PORT": "3000" }
|
|
}
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
**HTTP** connects to a running MCP server over `sse` by default, or `streamable-http` when requested:
|
|
|
|
```json
|
|
{
|
|
"mcp": {
|
|
"servers": {
|
|
"my-server": {
|
|
"url": "http://localhost:3100/mcp",
|
|
"transport": "streamable-http",
|
|
"headers": {
|
|
"Authorization": "Bearer ${MY_SECRET_TOKEN}"
|
|
},
|
|
"connectionTimeoutMs": 30000
|
|
}
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
- `transport` may be set to `"streamable-http"` or `"sse"`; when omitted, OpenClaw uses `sse`
|
|
- `type: "http"` is a CLI-native downstream shape; use `transport: "streamable-http"` in OpenClaw config. `openclaw mcp set` and `openclaw doctor --fix` normalize the common alias.
|
|
- only `http:` and `https:` URL schemes are allowed
|
|
- `headers` values support `${ENV_VAR}` interpolation
|
|
- a server entry with both `command` and `url` is rejected
|
|
- URL credentials (userinfo and query params) are redacted from tool
|
|
descriptions and logs
|
|
- `connectionTimeoutMs` overrides the default 30-second connection timeout for
|
|
both stdio and HTTP transports
|
|
|
|
##### Tool naming
|
|
|
|
OpenClaw registers bundle MCP tools with provider-safe names in the form
|
|
`serverName__toolName`. For example, a server keyed `"vigil-harbor"` exposing a
|
|
`memory_search` tool registers as `vigil-harbor__memory_search`.
|
|
|
|
- characters outside `A-Za-z0-9_-` are replaced with `-`
|
|
- fragments that would start with a non-letter get a letter prefix, so numeric
|
|
server keys such as `12306` become provider-safe tool prefixes
|
|
- server prefixes are capped at 30 characters
|
|
- full tool names are capped at 64 characters
|
|
- empty server names fall back to `mcp`
|
|
- colliding sanitized names are disambiguated with numeric suffixes
|
|
- final exposed tool order is deterministic by safe name to keep repeated embedded-agent
|
|
turns cache-stable
|
|
- profile filtering treats all tools from one bundle MCP server as plugin-owned
|
|
by `bundle-mcp`, so profile allowlists and deny lists can include either
|
|
individual exposed tool names or the `bundle-mcp` plugin key
|
|
|
|
#### Embedded OpenClaw settings
|
|
|
|
- Claude `settings.json` is imported as default embedded OpenClaw settings when the
|
|
bundle is enabled
|
|
- OpenClaw sanitizes shell override keys before applying them
|
|
|
|
Sanitized keys:
|
|
|
|
- `shellPath`
|
|
- `shellCommandPrefix`
|
|
|
|
#### Embedded OpenClaw LSP
|
|
|
|
- enabled Claude bundles can contribute LSP server config
|
|
- OpenClaw loads `.lsp.json` plus any manifest-declared `lspServers` paths
|
|
- bundle LSP config is merged into the effective embedded OpenClaw LSP defaults
|
|
- only supported stdio-backed LSP servers are runnable today; unsupported
|
|
transports still show up in `openclaw plugins inspect <id>`
|
|
|
|
### Detected but not executed
|
|
|
|
These are recognized and shown in diagnostics, but OpenClaw does not run them:
|
|
|
|
- Claude `agents`, `hooks.json` automation, `outputStyles`
|
|
- Cursor `.cursor/agents`, `.cursor/hooks.json`, `.cursor/rules`
|
|
- Codex inline/app metadata beyond capability reporting
|
|
|
|
## Bundle formats
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="Codex bundles">
|
|
Markers: `.codex-plugin/plugin.json`
|
|
|
|
Optional content: `skills/`, `hooks/`, `.mcp.json`, `.app.json`
|
|
|
|
Codex bundles fit OpenClaw best when they use skill roots and OpenClaw-style
|
|
hook-pack directories (`HOOK.md` + `handler.ts`).
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="Claude bundles">
|
|
Two detection modes:
|
|
|
|
- **Manifest-based:** `.claude-plugin/plugin.json`
|
|
- **Manifestless:** default Claude layout (`skills/`, `commands/`, `agents/`, `hooks/`, `.mcp.json`, `.lsp.json`, `settings.json`)
|
|
|
|
Claude-specific behavior:
|
|
|
|
- `commands/` is treated as skill content
|
|
- `settings.json` is imported into embedded OpenClaw settings (shell override keys are sanitized)
|
|
- `.mcp.json` exposes supported stdio tools to embedded OpenClaw
|
|
- `.lsp.json` plus manifest-declared `lspServers` paths load into embedded OpenClaw LSP defaults
|
|
- `hooks/hooks.json` is detected but not executed
|
|
- Custom component paths in the manifest are additive (they extend defaults, not replace them)
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="Cursor bundles">
|
|
Markers: `.cursor-plugin/plugin.json`
|
|
|
|
Optional content: `skills/`, `.cursor/commands/`, `.cursor/agents/`, `.cursor/rules/`, `.cursor/hooks.json`, `.mcp.json`
|
|
|
|
- `.cursor/commands/` is treated as skill content
|
|
- `.cursor/rules/`, `.cursor/agents/`, and `.cursor/hooks.json` are detect-only
|
|
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
## Detection precedence
|
|
|
|
OpenClaw checks for native plugin format first:
|
|
|
|
1. `openclaw.plugin.json` or valid `package.json` with `openclaw.extensions` — treated as **native plugin**
|
|
2. Bundle markers (`.codex-plugin/`, `.claude-plugin/`, or default Claude/Cursor layout) — treated as **bundle**
|
|
|
|
If a directory contains both, OpenClaw uses the native path. This prevents
|
|
dual-format packages from being partially installed as bundles.
|
|
|
|
## Runtime dependencies and cleanup
|
|
|
|
- Third-party compatible bundles do not get startup `npm install` repair. They
|
|
should be installed through `openclaw plugins install` and ship everything
|
|
they need in the installed plugin directory.
|
|
- OpenClaw-owned bundled plugins are either shipped lightweight in core or
|
|
downloadable through the plugin installer. Gateway startup never runs a
|
|
package manager for them.
|
|
- `openclaw doctor --fix` removes legacy staged dependency directories and can
|
|
recover downloadable plugins that are missing from the local plugin index when
|
|
config references them.
|
|
|
|
## Security
|
|
|
|
Bundles have a narrower trust boundary than native plugins:
|
|
|
|
- OpenClaw does **not** load arbitrary bundle runtime modules in-process
|
|
- Skills and hook-pack paths must stay inside the plugin root (boundary-checked)
|
|
- Settings files are read with the same boundary checks
|
|
- Supported stdio MCP servers may be launched as subprocesses
|
|
|
|
This makes bundles safer by default, but you should still treat third-party
|
|
bundles as trusted content for the features they do expose.
|
|
|
|
## Troubleshooting
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="Bundle is detected but capabilities do not run">
|
|
Run `openclaw plugins inspect <id>`. If a capability is listed but marked as
|
|
not wired, that is a product limit — not a broken install.
|
|
</Accordion>
|
|
|
|
<Accordion title="Claude command files do not appear">
|
|
Make sure the bundle is enabled and the markdown files are inside a detected
|
|
`commands/` or `skills/` root.
|
|
</Accordion>
|
|
|
|
<Accordion title="Claude settings do not apply">
|
|
Only embedded OpenClaw settings from `settings.json` are supported. OpenClaw does
|
|
not treat bundle settings as raw config patches.
|
|
</Accordion>
|
|
|
|
<Accordion title="Claude hooks do not execute">
|
|
`hooks/hooks.json` is detect-only. If you need runnable hooks, use the
|
|
OpenClaw hook-pack layout or ship a native plugin.
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
## Related
|
|
|
|
- [Install and Configure Plugins](/tools/plugin)
|
|
- [Building Plugins](/plugins/building-plugins) — create a native plugin
|
|
- [Plugin Manifest](/plugins/manifest) — native manifest schema
|