PROJECT_NAME

SHORT_DESCRIPTION

Project Structure
  • project-name/
    • package.jsonDESCRIPTION
    • index.jsDESCRIPTION
    • src/
      • module.jsDESCRIPTION
About

PARAGRAPH_1 — What the project/agent is and its primary purpose. Use bold for key terms, code for file/function references, and italic for emphasis.

PARAGRAPH_2 — How it works, key architectural decisions, notable patterns.

PARAGRAPH_3 — What makes it distinctive, typical use cases, or design philosophy.

System Architecture

INTRO_PARAGRAPH — Describe the overall architecture pattern and how modules connect.

flowchart TD
  A["Entry Point"]
  B["Module A"]
  C["Module B"]

  A --> B
  A --> C

  style A fill:#f0f0f0,stroke:#888,color:#333,stroke-width:1.5px,rx:10,ry:10
  style B fill:#f0f0f0,stroke:#888,color:#333,stroke-width:1.5px,rx:10,ry:10
  style C fill:#f0f0f0,stroke:#888,color:#333,stroke-width:1.5px,rx:10,ry:10
        
Tech Stack
TECHNOLOGY_NAME
What it does and why it's used in this project.
TECHNOLOGY_NAME
What it does and why it's used in this project.
Available Tools

INTRO_PARAGRAPH — Overview of the tool suite.

TOOL_NAME
What the tool does.
./tool-command --flag value
Dependencies: dep1 · dep2
FlagDefaultDescription
--flagvalueWhat it does
Core Components

INTRO_PARAGRAPH — How the components are organized.

COMPONENT_NAME
COMPONENT_DESCRIPTION
Key details: SPECIFICS
COMPONENT_NAME
COMPONENT_DESCRIPTION
Key details: SPECIFICS
API Endpoints

INTRO_PARAGRAPH — Describe the API surface.

MethodEndpointDescription
GET/api/endpointDESCRIPTION
POST/api/endpointDESCRIPTION
Database Schema

INTRO_PARAGRAPH — Describe the data model.

TABLE_NAME
TABLE_DESCRIPTION
Columns: id, name, created_at.
Authentication & Authorization

INTRO_PARAGRAPH — Describe the auth system.

AUTH_MECHANISM
AUTH_DESCRIPTION
Implementation: SPECIFICS
Workflows
WORKFLOW_NAME
1 ToolName — description of step
2 ToolName — description of step
3 ToolName — description of step
Config & Environment

INTRO_PARAGRAPH — Describe configuration and environment variables.

CONFIG_ITEM
CONFIG_DESCRIPTION
Details: SPECIFICS
Deploy & Infrastructure

INTRO_PARAGRAPH — Describe deployment setup.

DEPLOY_ITEM
DEPLOY_DESCRIPTION
Details: SPECIFICS
Speed & Performance

INTRO_PARAGRAPH — Performance characteristics and optimization strategies.

PERFORMANCE_ITEM
PERFORMANCE_DESCRIPTION
Metrics: SPECIFICS
Improvement Areas
ISSUE_TITLE
ISSUE_DESCRIPTION — 2–3 sentences explaining the problem.
What's missing: CONCRETE_SUGGESTION
ISSUE_TITLE
ISSUE_DESCRIPTION
What's missing: CONCRETE_SUGGESTION