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, 03:37 UTC
| 1 | # AGENTS.md |
| 2 | |
| 3 | TypeScript provider guidance. |
| 4 | |
| 5 | ## Scope |
| 6 | |
| 7 | Provider packages adapt Composio tools and sessions to AI frameworks such as OpenAI, Anthropic, Google, LangChain, Mastra, Vercel, LlamaIndex, Cloudflare, Claude Agent SDK, and TypeSafe. |
| 8 | |
| 9 | ## Skill Routing |
| 10 | |
| 11 | Use `typescript-providers` for provider implementation and docs/examples. Use `typescript-testing` for package tests. Use `cross-sdk-parity` when a provider has a Python counterpart. |
| 12 | |
| 13 | ## Commands |
| 14 | |
| 15 | Run from the repository root: |
| 16 | |
| 17 | ```bash |
| 18 | pnpm create:provider <provider-name> [--agentic] |
| 19 | pnpm --filter @composio/<provider> test |
| 20 | pnpm --filter @composio/<provider> typecheck |
| 21 | pnpm build:packages |
| 22 | ``` |
| 23 | |
| 24 | ## Rules |
| 25 | |
| 26 | - Keep provider-specific behavior inside the provider package. |
| 27 | - Preserve framework-native tool shapes and naming conventions. |
| 28 | - Tool schemas obtained through `ToolSchema` are normalized by core. Every provider that accepts a raw `Tool` must call `deduplicateJsonSchemaRequiredArrays` from `@composio/core` immediately before emitting a vendor JSON Schema, after any provider-specific schema transformations. A ToolSchema-normalized API tool needs no additional call unless it is transformed afterward. |
| 29 | - Add tests that cover wrapping, execution handling, and version-specific compatibility. |
| 30 | - Update examples or docs when provider setup or public usage changes. |