libxmtp / sdks
AGENTS.md127 starsChanged 11 days agoMITView on GitHub
Shared behavior belongs in Rust/core and crates/xmtp_sdk; platform packages wrap it. Never edit generated bindings. Keep native streams open through retryable faults; core owns ordered recovery and durable delivery progress. For JS/TS SDKs (node, browser, agent, react-native): - Use the root pnpm workspace. dev/nix-shell 'just install-js' installs it; dev/nix-shell 'just js sdk-products [node|browser|react-native]' stages products. - Use the task graph; never --parallel or --no-sort. Agent consumes Node's dist. Read package preparation when changing build routes. - Client creation requires explicit…
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 31,439 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 repository21 other files it gives its agents.
- AGENTS.mdAGENTS.md
- docs/AGENTS.mdAGENTS.md
- .github/workflows/AGENTS.mdAGENTS.md
- nix/AGENTS.mdAGENTS.md
- proto/AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- .github/workflows/CLAUDE.mdCLAUDE.md
- nix/CLAUDE.mdCLAUDE.md
- proto/CLAUDE.mdCLAUDE.md
- sdks/CLAUDE.mdCLAUDE.md
- authoring-specsSkill
- check-ciSkill
- checking-spec-complianceSkill
- reviewing-specsSkill
- smoke-checkSkill
- working-with-nixSkill
- working-with-worktreesSkill
- writing-agent-docsSkill
- writing-rustSkill
- writing-rust-testsSkill
- writing-typescriptSkill
The file
We split this AGENTS.md into the rules it gives an agent
2 rules. About 0 are common, 0 are distinctive, and 2 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈0
Distinctive · estimate
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 9
Use the root pnpm workspace.
- Very specific: line 11
Use the task graph; never --parallel or --no-sort.
≈ “Common” is an estimate: at least 1 in 5 of the 40,246 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
XMTP SDKs
Shared behavior belongs in Rust/core and crates/xmtp_sdk; platform packages wrap
it. Never edit generated bindings. Keep native streams open through retryable
faults; core owns ordered recovery and durable delivery progress.
For JS/TS SDKs (node, browser, agent, react-native):
- Use the root pnpm workspace.
dev/nix-shell 'just install-js'installs it;dev/nix-shell 'just js sdk-products [node|browser|react-native]'stages products. - Use the task graph; never
--parallelor--no-sort. Agent consumes Node'sdist. Read package preparation when changing build routes. - Client creation requires explicit
backend; Browser also requiresstorage.envlabels database files, never selects a backend. Preserve the API cache key<backendUrl>|<appVersion>. - Tests need
just backend upthrough Nix unless documented otherwise. - Iteration acknowledges the previous message on the next read; close/end do not acknowledge. Callback mode acknowledges only after callback success and cannot also iterate. Keep typed failures; never automatically replace failed readers. Read delivery rules for stream work.
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.