Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
| 1 | # AGENTS.md |
| 2 | |
| 3 | TypeScript workspace guidance for AI agents. |
| 4 | |
| 5 | ## Scope |
| 6 | |
| 7 | `ts/` contains the TypeScript SDK packages, examples, CLI, and runtime E2E tests. |
| 8 | |
| 9 | ## Skill Routing |
| 10 | |
| 11 | - Use `typescript-sdk` for `@composio/core`, shared TypeScript package behavior, generated SDK surfaces, and modifiers. |
| 12 | - Use `typescript-providers` for packages under `ts/packages/providers/`. |
| 13 | - Use `typescript-testing` for Vitest, typecheck, package builds, examples, or runtime E2E test selection. |
| 14 | - Use `cli-command` or `cli-e2e` for `ts/packages/cli/` and `ts/e2e-tests/cli/`. |
| 15 | - Use `cli-release` for first-party CLI beta builds, stable promotion, release verification, or recovery. |
| 16 | |
| 17 | ## Commands |
| 18 | |
| 19 | Run from the repository root: |
| 20 | |
| 21 | ```bash |
| 22 | pnpm build:packages |
| 23 | pnpm typecheck |
| 24 | pnpm lint:packages |
| 25 | pnpm test |
| 26 | pnpm test:e2e:node |
| 27 | pnpm test:e2e:cloudflare |
| 28 | pnpm test:e2e:cli |
| 29 | ``` |
| 30 | |
| 31 | ## Rules |
| 32 | |
| 33 | - Do not edit `ts/vendor/`; those submodules are read-only references. |
| 34 | - Keep generated outputs owned by their generator. |
| 35 | - Add a Changesets note for each affected published TypeScript package; cross-language changes also target the private `@composio/python-sdk` marker. Stable and beta SDK publication uses the unified request workflow. |
| 36 | - Never add changesets for `@composio/cli` while `.changeset/config.json` ignores it; record CLI notes in `ts/packages/cli/CHANGELOG.md` instead. |
| 37 | - Prefer focused package tests before broad workspace tests. |
| 38 | - Parse untyped or external data (API payloads, JSON, `unknown`) at the boundary with schemas and let inferred types flow downstream: zod in SDK packages (`@composio/core`, providers, shared packages), `effect/Schema` in `ts/packages/cli/`. Never hand-roll structural guards (`'x' in obj` / `typeof` chains) or cast parsed JSON with `as`. |