Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
AGENTS.md
Documentation-site guidance for AI agents working under docs/.
Scope
docs/ is a Fumadocs/Next.js site. Docs PRs branch from next and target next.
Read Next
- Use the
docs-decisionsskill for docs content, changelogs, decisions, docs automation, or docs review. - Context references live under
docs/agent-guidance/context/; usedocs/agent-guidance/context/twoslash.mdbefore editing typed MDX examples. - Read
docs/agent-guidance/context/code-examples.mdbefore editing code examples. - Agent workflow prompts live under
docs/agent-guidance/agents/. - Changelog guidance lives at
docs/agent-guidance/guides/changelog.md. - Decision records live under
docs/decisions/; readdocs/decisions/README.mdfirst.
Commands
Run commands from docs/:
bun install
bun run dev
bun run build
bun run types:check
bun run lint
bun run lint:links
bun run test
bun run test:integration
bun run generate:toolkits
bun run generate:meta-tools
bun run generate:api-index
bun run check:code-examples
bun run check:api-snippets
bun run check:python-snippets
bun run test:python-snippets
bun run check:typescript-snippets
bun run inventory:code-examples
Rules
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_LABELfromlib/toolkit-count.tsor%TOOLKIT_COUNT%in Markdown/MDX for the shared count.Production Twoslash and
check:typescript-snippetscover different maintained TypeScript surfaces. Readdocs/agent-guidance/context/twoslash.mdfor coverage, installed-version boundaries, and annotation rules.Maintained operation examples offer Python, TypeScript, and API options, or a specific justified exception. Read
docs/agent-guidance/context/code-examples.mdfor the full inventory, generated/historical limits, check commands, and scoped markers. Passing checks do not establish semantic equivalence or justify an exemption.Parse untyped or external data (JSON files, fetched payloads, framework page data) once at the boundary with zod schemas and let
z.infertypes flow downstream. Never hand-roll structural guards ('x' in obj/typeofchains), cast parsed JSON withas, or fake validation withz.custom(() => true).Follow the root Contribution Policy, including its designated PR reviewer and third-party links policy. 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.
Internal docs links must be relative site paths such as
/docs/...,/reference/..., or/assets/....API reference pages and toolkit/meta-tool data are generated. Do not hand-edit generated data unless the local generator owns it.
Changelog entries require
titleanddatefrontmatter, and dates useYYYY-MM-DD.Prefer cURL for API interactions because docs are consumed by humans and AI crawlers.
Links to
dashboard.composio.devmust carryutm_source=docs,utm_medium, andutm_campaign(content links useutm_medium=contentandutm_campaign=<page-slug>), and any link with a path must be a go-link (/~/project/...or/~/org/...) or/login. Never linkapp.composio.devorplatform.composio.dev. Oxlint enforces TS/TSX;tests/static/dashboard-links.test.tsenforces MDX.