Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
Mirrored from https://github.com/Camo67/composio.git
Synced Nov 21, 06:00 UTC
| 1 | # AGENTS.md |
| 2 | |
| 3 | Core TypeScript SDK guidance. |
| 4 | |
| 5 | ## Scope |
| 6 | |
| 7 | This directory owns `@composio/core`: the main `Composio` class, models, providers, services, types, utilities, and generated integration surfaces. |
| 8 | |
| 9 | ## Skill Routing |
| 10 | |
| 11 | Use `typescript-sdk` for feature work and `typescript-testing` for verification. Use `cross-sdk-parity` when behavior must match the Python SDK or generated client contracts. |
| 12 | |
| 13 | ## Commands |
| 14 | |
| 15 | Run from the repository root unless a package-local command is more precise: |
| 16 | |
| 17 | ```bash |
| 18 | pnpm --filter @composio/core test |
| 19 | pnpm --filter @composio/core typecheck |
| 20 | pnpm typecheck |
| 21 | pnpm test |
| 22 | ``` |
| 23 | |
| 24 | ## Rules |
| 25 | |
| 26 | - Keep public API changes typed and documented. |
| 27 | - Add regression coverage for behavior changes. |
| 28 | - Do not hand-edit generated client code unless the generator output is explicitly in scope. |
| 29 | - Check Python parity before changing shared concepts such as tools, toolkits, sessions, auth configs, or connected accounts. |
| 30 | - Parse untyped or external data (API payloads, JSON, `unknown`) at the boundary with zod schemas and let `z.infer` types flow downstream. Never hand-roll structural guards (`'x' in obj` / `typeof` chains) or cast parsed JSON with `as` — an assertion is not validation. |