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 | Documentation-site guidance for AI agents working under `docs/`. |
| 4 | |
| 5 | ## Scope |
| 6 | |
| 7 | `docs/` is a Fumadocs/Next.js site. Docs PRs branch from `next` and target `next`. |
| 8 | |
| 9 | ## Read Next |
| 10 | |
| 11 | - Use the `docs-decisions` skill for docs content, changelogs, decisions, docs automation, or docs review. |
| 12 | - Context references live under `docs/agent-guidance/context/`; use `docs/agent-guidance/context/twoslash.md` before editing typed MDX examples. |
| 13 | - Read `docs/agent-guidance/context/code-examples.md` before editing code examples. |
| 14 | - Agent workflow prompts live under `docs/agent-guidance/agents/`. |
| 15 | - Changelog guidance lives at `docs/agent-guidance/guides/changelog.md`. |
| 16 | - Decision records live under `docs/decisions/`; read `docs/decisions/README.md` first. |
| 17 | |
| 18 | ## Commands |
| 19 | |
| 20 | Run commands from `docs/`: |
| 21 | |
| 22 | ```bash |
| 23 | bun install |
| 24 | bun run dev |
| 25 | bun run build |
| 26 | bun run types:check |
| 27 | bun run lint |
| 28 | bun run lint:links |
| 29 | bun run test |
| 30 | bun run test:integration |
| 31 | bun run generate:toolkits |
| 32 | bun run generate:meta-tools |
| 33 | bun run generate:api-index |
| 34 | bun run check:code-examples |
| 35 | bun run check:api-snippets |
| 36 | bun run check:python-snippets |
| 37 | bun run test:python-snippets |
| 38 | bun run check:typescript-snippets |
| 39 | bun run inventory:code-examples |
| 40 | ``` |
| 41 | |
| 42 | ## Rules |
| 43 | |
| 44 | - Catalog-size copy uses "apps" in marketing text, including site descriptions, "toolkits" in technical documentation about toolkits, and "tools" only for an individual toolkit's actions. Use `TOOLKIT_COUNT_LABEL` from `lib/toolkit-count.ts` or `%TOOLKIT_COUNT%` in Markdown/MDX for the shared count. |
| 45 | |
| 46 | - Production Twoslash and `check:typescript-snippets` cover different maintained TypeScript surfaces. Read `docs/agent-guidance/context/twoslash.md` for coverage, installed-version boundaries, and annotation rules. |
| 47 | - Maintained operation examples offer Python, TypeScript, and API options, or a specific justified exception. Read `docs/agent-guidance/context/code-examples.md` for the full inventory, generated/historical limits, check commands, and scoped markers. Passing checks do not establish semantic equivalence or justify an exemption. |
| 48 | - Parse untyped or external data (JSON files, fetched payloads, framework page data) once at the boundary with zod schemas and let `z.infer` types flow downstream. Never hand-roll structural guards (`'x' in obj` / `typeof` chains), cast parsed JSON with `as`, or fake validation with `z.custom(() => true)`. |
| 49 | - Follow the root [Contribution Policy](../CONTRIBUTING.md#contribution-policy), including its designated PR reviewer and [third-party links policy](../CONTRIBUTING.md#third-party-links-in-docs). Authoritative technical references needed to use or contribute to Composio are allowed; other third-party links and promotional content must fit the listed exceptions. Route partnership requests to https://composio.dev/contact. |
| 50 | - Internal docs links must be relative site paths such as `/docs/...`, `/reference/...`, or `/assets/...`. |
| 51 | - API reference pages and toolkit/meta-tool data are generated. Do not hand-edit generated data unless the local generator owns it. |
| 52 | - Changelog entries require `title` and `date` frontmatter, and dates use `YYYY-MM-DD`. |
| 53 | - Prefer cURL for API interactions because docs are consumed by humans and AI crawlers. |
| 54 | - Links to `dashboard.composio.dev` must carry `utm_source=docs`, `utm_medium`, and `utm_campaign` (content links use `utm_medium=content` and `utm_campaign=<page-slug>`), and any link with a path must be a go-link (`/~/project/...` or `/~/org/...`) or `/login`. Never link `app.composio.dev` or `platform.composio.dev`. Oxlint enforces TS/TSX; `tests/static/dashboard-links.test.ts` enforces MDX. |