Skip to content

AGENTS.md

Latest commit

 

History

History
65 lines (42 loc) · 4.56 KB

AGENTS.md

File metadata and controls

65 lines (42 loc) · 4.56 KB
Raw

Agent instructions

Entry point for AI/LLM agents working in or with this repository. Pointers below; nothing canonical lives in this file.

Repository overview

  • README.md — what this repo is, package list, quick start
  • CONTRIBUTING.md — contribution guidelines, commit format, PR process
  • .claude/CLAUDE.md — development conventions, Nx commands, testing matrix, library-specific notes (read by Claude Code; the canonical development-conventions doc)
  • .cursor/.cursorrules — same conventions for Cursor (read by Cursor IDE)

Agent skills

Reusable agent skills for working in this Nx workspace (Nx-related: nx-workspace, nx-generate, nx-import, nx-plugins, nx-run-tasks, link-workspace-packages) live at:

Both directories currently hold the same content. Treat .agents/skills/ as the source of truth; the .claude/skills/ copy is kept in sync until Claude Code can discover skills from .agents/skills/ directly.

Per-package usage

Each package has its own README with usage examples and API notes:

Helping users of a published @supabase/* package

The published npm tarball for each package ships everything an agent needs to give a correct, version-pinned answer. After npm install @supabase/<package>, an agent helping with that package should look inside node_modules/@supabase/<package>/:

  • AGENTS.md — per-package agent entry point (read this first; it points at the resources below).
  • README.md — usage and quick-start.
  • src/ — full API source with TSDoc. Every public method and type has JSDoc, most have @example blocks. Read source here for the canonical, version-pinned answer instead of guessing from training data.
  • migrations/ — per-theme migration notes for changes that need caller action.

Source files ship via npm because every package's files array in package.json includes "src". Migration notes ship via "migrations". Per-package AGENTS.md ships via "AGENTS.md". All three are version-pinned by virtue of being inside the installed package.

We deliberately do NOT ship per-package skills or duplicate docs-site content. The TSDoc-in-source IS the canonical API documentation for the SDK packages.

For higher-level Supabase guidance (the documentation site, MCP tools, schema management workflows, project setup), use the centralized Supabase agent skills:

npx skills add supabase/agent-skills

Or use the Supabase Plugin for AI Coding Agents to install the agent skills together with the Supabase MCP server in one step. See also: Agent Skills documentation.

Migration notes

Migration notes live close to the code they describe, so they ship via npm alongside the package.

  • Per-package migrations: packages/core/<package>/migrations/<theme>.md — one file per migration theme (e.g. <new-feature-adoption>.md). Each file describes what changed, who is affected, and what callers need to do.
  • Cross-cutting migrations (affecting the whole repo or all packages): docs/MIGRATION.md — one H2 section per theme (e.g. Node.js version drops). Low-frequency by design; split into a directory only if the file grows past a handful of themes.

Other documentation