Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
TypeScript agentic-aiagentsaiai-agentsaiagentsdeveloper-toolsfunction-callinggpt-4javascriptjsllmllmopsmcppythonremote-mcp-serverssetypescript
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. - 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
Rules
- TypeScript code blocks in MDX are checked during docs builds. Use
docs/agent-guidance/context/twoslash.mdbefore changing typed examples. - 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). - 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.