Skip to content

Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

2.2 KB
Raw Blame

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-decisions skill for docs content, changelogs, decisions, docs automation, or docs review.
  • Context references live under docs/agent-guidance/context/; use docs/agent-guidance/context/twoslash.md before 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/; read docs/decisions/README.md first.

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.md before 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.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).
  • 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 title and date frontmatter, and dates use YYYY-MM-DD.
  • Prefer cURL for API interactions because docs are consumed by humans and AI crawlers.
  • 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.