atomicbot / extensions
AGENTS.md325 starsChanged 7 months agoMITView on GitHub
This directory contains bundled plugins. Treat it as the same boundary that third-party plugins see. - Extension production code should import from openclaw/plugin-sdk/* and its own local barrels such as ./api.ts and ./runtime-api.ts. - Do not import core internals from src/, src/channels/, src/plugin-sdk-internal/, or another extension's src/. - Do not use relative imports that escape the current extension package root. - Keep plugin metadata accurate in openclaw.plugin.json and the package openclaw block so discovery and setup work without executing plugin…
We split this AGENTS.md into the rules it gives an agent
11 rules. About 0 are common, 6 are distinctive, and 5 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈6
Distinctive · estimate
This author's own choices. Worth a look.
5
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 29
Do not import core internals from src/, src/channels/, src/plugin-sdk-internal/, or another extension's src/.
- Distinctive: line 31
Do not use relative imports that escape the current extension package root.
- Very specific: line 32
Keep plugin metadata accurate in openclaw.plugin.json and the package openclaw block so discovery and setup work without executing plugin …
- Very specific: line 34
Treat files like src/, onboard.ts, and other local helpers as private unless you intentionally promote them through api.ts and, if needed, …
- Very specific: line 37
If core or core tests need a bundled plugin helper, export it from api.ts first instead of letting them deep-import extension internals.
- Very specific: line 42
Before adding a new provider-local wrapStreamFn, buildReplayPolicy, normalizeToolSchemas, inspectToolSchemas, or compat patch helper, check …
- Distinctive: line 46
If two bundled providers share the same replay policy shape, tool-schema compat rewrite, payload patch, or stream-wrapper chain, stop …
- Distinctive: line 50
Prefer named provider-family helpers over repeating raw option bags.
- Distinctive: line 57
If an extension needs a new seam, add a typed Plugin SDK subpath or additive export instead of reaching into core.
- Distinctive: line 59
Keep new plugin-facing seams backwards-compatible and versioned.
- Distinctive: line 61
When intentionally expanding the contract, update the docs, exported subpath list, package exports, and API/contract checks in the same …
≈ “Common” is an estimate: at least 1 in 5 of the 36,368 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Extensions Boundary
This directory contains bundled plugins. Treat it as the same boundary that third-party plugins see.
Public Contracts
- Docs:
docs/plugins/building-plugins.mddocs/plugins/architecture.mddocs/plugins/sdk-overview.mddocs/plugins/sdk-entrypoints.mddocs/plugins/sdk-runtime.mddocs/plugins/sdk-channel-plugins.mddocs/plugins/sdk-provider-plugins.mddocs/plugins/manifest.md
- Definition files:
src/plugin-sdk/plugin-entry.tssrc/plugin-sdk/core.tssrc/plugin-sdk/provider-entry.tssrc/plugin-sdk/channel-contract.tsscripts/lib/plugin-sdk-entrypoints.jsonpackage.json
Boundary Rules
- Extension production code should import from
openclaw/plugin-sdk/*and its own local barrels such as./api.tsand./runtime-api.ts. - Do not import core internals from
src/**,src/channels/**,src/plugin-sdk-internal/**, or another extension'ssrc/**. - Do not use relative imports that escape the current extension package root.
- Keep plugin metadata accurate in
openclaw.plugin.jsonand the packageopenclawblock so discovery and setup work without executing plugin code. - Treat files like
src/**,onboard.ts, and other local helpers as private unless you intentionally promote them throughapi.tsand, if needed, a matchingsrc/plugin-sdk/<id>.tsfacade. - If core or core tests need a bundled plugin helper, export it from
api.tsfirst instead of letting them deep-import extension internals. - For provider plugins, keep auth, onboarding, catalog selection, and vendor-only product behavior local to the plugin. Do not move those into core just because two providers look similar.
- Before adding a new provider-local
wrapStreamFn,buildReplayPolicy,normalizeToolSchemas,inspectToolSchemas, or compat patch helper, check whether the same behavior already exists throughopenclaw/plugin-sdk/*. Reuse shared family helpers first. - If two bundled providers share the same replay policy shape, tool-schema compat rewrite, payload patch, or stream-wrapper chain, stop copying the logic. Extract one shared helper and migrate both call sites in the same change.
- Prefer named provider-family helpers over repeating raw option bags. If a provider needs OpenAI-style Anthropic tool payload compat, Gemini schema cleanup, or an XAI compat patch, use a named shared helper instead of inlining the policy knobs again.
Expanding The Boundary
- If an extension needs a new seam, add a typed Plugin SDK subpath or additive export instead of reaching into core.
- Keep new plugin-facing seams backwards-compatible and versioned. Third-party plugins consume this surface.
- When intentionally expanding the contract, update the docs, exported subpath list, package exports, and API/contract checks in the same change.
Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 28,693 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository65 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- extensions/CLAUDE.mdCLAUDE.md
- openclaw-ghsa-maintainerSkill
- openclaw-parallels-smokeSkill
- openclaw-pr-maintainerSkill
- openclaw-qa-testingSkill
- openclaw-release-maintainerSkill
- openclaw-test-heap-leaksSkill
- parallels-discord-roundtripSkill
- security-triageSkill
- update-openclaw-bundleSkill
- 1passwordSkill
- apple-notesSkill
- apple-remindersSkill
- bear-notesSkill
- blogwatcherSkill
- blucliSkill
- bluebubblesSkill
- camsnapSkill
- canvasSkill
- clawhubSkill
- coding-agentSkill
- discordSkill
- eightctlSkill
- geminiSkill
- gh-issuesSkill
- gifgrepSkill
- githubSkill
- gogSkill
- goplacesSkill
- healthcheckSkill
- himalayaSkill
- imsgSkill
- mcporterSkill
- model-usageSkill
- nano-pdfSkill
- node-connectSkill
- notionSkill
- obsidianSkill
- openai-whisper-apiSkill
- openai-whisperSkill
- openhueSkill
- oracleSkill
- ordercliSkill
- peekabooSkill
- sagSkill
- session-logsSkill
- sherpa-onnx-ttsSkill
- skill-creatorSkill
- slackSkill
- songseeSkill
- sonoscliSkill
- spotify-playerSkill
- summarizeSkill
- taskflow-inbox-triageSkill
- taskflowSkill
- things-macSkill
- tmuxSkill
- trelloSkill
- The first 60 shown.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.