Runtime Web

Unified Serverless Framework for Full-Stack TypeScript Applications

AGENTS.md Generator

Generate a customized AGENTS.md file for your project. Fill out the configuration form below to create a comprehensive guide for AI coding agents working with your codebase.

Project name is required

Project intent is required

Domains (Bounded Contexts in Your Repo)

Define logical areas of your codebase to help AI agents navigate

Critical Invariants

Lambda bundle MUST remain <10MB compressed (AWS hard limit)
All handlers MUST use typed dependency injection via event.ties

Rules that must always hold true in your project

e.g., >=18.0.0

e.g., 5.x

Local Services

Services available during local development

Environment Assumptions

Do not assume internet access unless explicitly granted
Do not assume AWS credentials during build/test
AWS credentials required only for deployment

Assumptions AI agents should make about the environment

Core Commands

e.g., npm install

e.g., npm run dev

Test Commands

e.g., npm test

e.g., npm run test:unit

e.g., npm run test:integration

e.g., npm run test:e2e

e.g., npm run test:coverage

Lint Commands

e.g., npm run lint

e.g., npm run lint:fix

e.g., npm run format

Build Commands

e.g., npm run build

e.g., npm run build:lambda

e.g., npm run cdk:synth

Deploy Commands (Optional)

e.g., npm run deploy:dev

e.g., npm run deploy:staging

e.g., npm run deploy:prod

Database Commands (Optional)

e.g., npm run db:migrate

e.g., npm run db:seed

e.g., npm run db:studio

Code Style

Spaces (1-8)

Characters (40-200)

Naming Conventions

e.g., kebab-case.ts

e.g., PascalCase

e.g., camelCase

e.g., UPPER_SNAKE_CASE

e.g., PascalCase

Import Order Rules

Node.js built-ins (fs, path)
External packages (react, @aws-sdk/*)
Internal aliases (@/services, @/types)
Relative imports (./utils)

Order in which imports should be organized

Test File Locations

e.g., tests/unit/ or src/**/__tests__/

e.g., tests/integration/

e.g., tests/e2e/

Testing Rules

If tests fail, fix them or revert the change
Do not delete failing tests without documented reason
Mock external services (AWS SDK, APIs) in unit tests
Use real services in integration tests (with test accounts)

Guidelines for how AI agents should handle tests

Instructions for how secrets should be handled

Forbidden Logging Items

secrets
tokens
passwords
PII
API keys

Items that must never be logged

Forbidden Operations

Dropping/truncating database tables
Deleting S3 buckets or objects
Removing CloudFormation stacks
Modifying IAM to weaken security
Deleting production data

Operations that AI agents must never perform

Public Contracts (Do Not Change)

API endpoint paths and methods
Request/response schemas
Event formats (if using EventBridge/SQS)

Public API contracts that must remain stable

Infrastructure Constraints

VPC/network topology
IAM policies (except scoped additions)
Database schemas (without migration)

Infrastructure that should not be modified

Generated Files (Do Not Edit)

dist/ — build output
cdk.out/ — CDK synthesis
*.lock files — unless from dependency install

Files that are auto-generated and should not be manually edited

Define different agent personas with specific roles and responsibilities

Checklist Items

Code compiles without errors
All tests pass
Lint passes
No secrets in code
Documentation updated if needed

At least one item is required

No Preview Available

Fill out the configuration form and click "Generate AGENTS.md"
to see a preview of your generated file.