Runtime Web

Unified Serverless Framework for Full-Stack TypeScript Applications

AGENTS.md Generator

Create AI-Ready Project Documentation

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.

The name of your project (e.g., "My Awesome App")

What your project does (e.g., "A web app for task management")

Domains (Bounded Contexts in Your Repo)

Define logical areas of your codebase to help AI agents navigate

Rules that must always hold true in your project

  • Lambda bundle MUST remain <10MB compressed (AWS hard limit)

  • All handlers MUST use typed dependency injection via `event.ties`

e.g., >=18.0.0

e.g., 5.x

Local Services

Services available during local development

Assumptions AI agents should make about the environment

  • Do **not** assume internet access unless explicitly granted

  • Do **not** assume AWS credentials during build/test

  • AWS credentials required only for deployment

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

Order in which imports should be organized

  • Node.js built-ins (`fs`, `path`)

  • External packages (`react`, `@aws-sdk/*`)

  • Internal aliases (`@/services`, `@/types`)

  • Relative imports (`./utils`)

Test File Locations

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

e.g., tests/integration/

e.g., tests/e2e/

Guidelines for how AI agents should handle tests

  • 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)

Instructions for how secrets should be handled

Items that must never be logged

  • secrets

  • tokens

  • PII

Operations that AI agents must never perform

  • Dropping/truncating database tables

  • Deleting S3 buckets or objects

  • Removing CloudFormation stacks

  • Modifying IAM to weaken security

  • Deleting production data

Public API contracts that must remain stable

  • API endpoint paths and methods

  • Request/response schemas

  • GraphQL schema (if applicable)

  • Event formats (if using EventBridge/SQS)

Infrastructure that should not be modified

  • VPC/network topology

  • IAM policies (except scoped additions)

  • Database schemas (without migration)

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

  • `dist/` — build output

  • `cdk.out/` — CDK synthesis

  • `*.lock` files — unless from dependency install

  • Generated types from OpenAPI/GraphQL

Define different agent personas with specific roles and responsibilities

At least one item is required

  • Code compiles: `yarn build`

  • Types correct: `yarn typecheck` (if separate)

  • No TypeScript errors

  • Tests pass: `yarn test`

  • New behavior covered by tests

  • No flaky tests introduced

  • Lambda bundle <10MB

  • No unnecessary large dependencies

  • Lint passes: `yarn lint`

  • Code formatted: `yarn format`

  • No constraint violations (Section 10)

  • Follows coding conventions (Section 5)

  • No secrets in code

  • No weakened auth

  • No destructive ops without approval

  • README updated if needed

  • API docs updated if endpoints changed

  • Breaking changes documented

No Preview Available

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

Runtime Web

Unified Serverless Framework for Full-Stack TypeScript Applications

AGENTS.md GeneratorContact

© 2026 Runtime Web. All rights reserved.