Get Started
PreviousNext

AI Agent Rules

Canonical cross-agent execution contract for implementing features with docs + kit + examples.

What It Does

This page defines how coding agents should implement features in Creatorem using a single canonical rules contract and generated agent-specific adapters.

When To Use

  • You want consistent behavior across Codex, Claude, Cursor, Windsurf, and other agents.
  • You want feature work to be capability-driven instead of guess-driven.
  • You want reusable implementation decisions (kit/*) with real integration patterns (examples/*).

Prerequisites

  • Access to the repository root.
  • Access to docs capability endpoints (/mcp-index.json, /llms.mdx/*) when using MCP retrieval.

How To Use

Use canonical contract as source of truth.

Canonical contract path:

docs/agent-rules/creatorem-agent-rules.contract.v1.json

Consume an adapter for your coding agent.

AgentAdapter file
CodexAGENTS.md
ClaudeCLAUDE.md
Cursor.cursor/rules/creatorem-agent-rules.mdc
Windsurf.windsurfrules
Other agentsdocs/agent-rules/adapters/generic-agent-rules.md

Use MCP discovery before coding.

  1. Read capability metadata from /mcp-index.json.
  2. Resolve the target docs page(s).
  3. Pull LLM-ready content from /llms.mdx/* only for selected pages.

Map docs capabilities to implementation layers.

Capability familyMain implementation truthIntegration references
Settingskit/settings/*examples/pco-dashboard/*settings*, examples/pco-mobile/*settings*
Translations/i18nkit/i18n/*, cross-env filtersexamples/pco-dashboard/config/i18n.config.ts, examples/pco-dashboard/lib/init-cross-env-filters.ts
Database workflowroot package.json db scripts + supabase/*docs/database, docs/scripts, .creatorem schemas in examples

Maintain and validate adapters from canonical contract.

pnpm --filter creatorem docs:agents:generate
pnpm --filter creatorem docs:agents:check

Source Precedence

If sources disagree, resolve in this order:

  1. kit/* code and exports
  2. docs contract pages (MCP Context, Agent Recipe)
  3. examples/* integration implementations

MCP Context

capability: agent_rules_contract entrypoints: - docs/agent-rules/creatorem-agent-rules.contract.v1.json - AGENTS.md - CLAUDE.md - .cursor/rules/creatorem-agent-rules.mdc - .windsurfrules - docs/agent-rules/adapters/generic-agent-rules.md - apps/creatorem/scripts/generate-agent-rules.mts - apps/creatorem/scripts/check-agent-rules.mts - apps/creatorem/app/mcp-index.json/route.ts - apps/creatorem/app/llms.mdx/[...slug]/route.ts inputs: - coding_task - capability_selection outputs: - deterministic_agent_execution_rules - synchronized_agent_adapter_files constraints: - canonical contract is the only editable source for adapter content - capability IDs referenced by rules must exist in mcp-index - path references in contract must resolve in repository side_effects: - adapter files are regenerated from canonical contract

Agent Recipe

  1. Select capability IDs from /mcp-index.json.
  2. Read target docs pages and extract implementation entrypoints.
  3. Implement in kit/* first when behavior is reusable.
  4. Wire app-level integration using existing example patterns.
  5. Run validation commands and report exact execution status.

Troubleshooting

  • If adapters are outdated, run pnpm --filter creatorem docs:agents:generate.
  • If contract checks fail on capability IDs, regenerate docs index and verify capability names.
  • If path references fail, update contract refs to real paths before regeneration.

How is this guide?

Last updated on 3/27/2026