Cursor Agent Context & Rules Scaffold

This is a scaffold package for setting up Cursor's AI agent context and rules system in your project.

What This Does

This scaffold helps you set up a structured system for:

• Rules - Prescriptive guidelines that enforce project conventions
• Context - Learned patterns and decision frameworks discovered during development

When you drop this into your .cursor/ folder, the agent will help you:

1. Analyze your codebase
2. Create appropriate rules based on your tech stack
3. Set up the context system for capturing patterns
4. Maintain and evolve the system as you develop

Quick Start

Option 1: NPM Package (Recommended)

Install and run the scaffold installer:

# Using npx (no installation needed)
npx cursor-agent-scaffold

# Or install globally
npm install -g cursor-agent-scaffold
cursor-scaffold

This will automatically copy all scaffold files to your .cursor/ folder.

Option 2: Copy the Scaffold

1. Copy the entire .cursor-scaffold/ folder contents into your project's .cursor/ folder:

   # Copy everything from .cursor-scaffold/ to .cursor/
   cp -r .cursor-scaffold/* .cursor/

2. The agent will automatically detect the scaffold and guide you through setup

Option 3: Manual Setup

1. Copy rules/scaffold-agent-context.mdc to .cursor/rules/
2. Copy README.md to .cursor/
3. Ask the agent: "Help me set up the context and rules system for this project"

What Gets Created

After setup, you'll have:

.cursor/
├── README.md                    # Documentation
├── rules/                       # Prescriptive rules
│   ├── scaffold-agent-context.mdc  # Setup guide (this file)
│   ├── naming-and-structure.mdc    # Created by agent
│   ├── lint-and-style.mdc          # Created by agent
│   ├── framework-patterns.mdc       # Created by agent
│   └── context-patterns.mdc         # Created by agent
└── context/                     # Learned patterns (created as needed)
    └── [pattern files].md

How It Works

1. Initial Setup: The agent analyzes your codebase and creates initial rules
2. Development: As you work, the agent captures patterns in context files
3. Evolution: Rules and context evolve as your project grows

Customization

The scaffold is designed to be:

• Framework-agnostic - Works with React, Vue, Angular, etc.
• Language-agnostic - Works with TypeScript, JavaScript, Python, etc.
• Project-agnostic - Adapts to your specific conventions

The agent will customize rules based on:

• Your tech stack (detected from config files)
• Your existing code patterns
• Your project structure

Next Steps

1. Copy this scaffold into your .cursor/ folder
2. Ask the agent to analyze your codebase and create initial rules:
   • "Analyze my codebase and create initial rules based on my tech stack"
   • "Help me set up the context and rules system for this project"
3. Start developing - context files will be created as patterns emerge

Example Agent Prompts

After setup, try these prompts:

• "Analyze my codebase and create initial rules"
• "What rules should I have for this project?"
• "Help me document the form validation patterns we've been using"
• "Create a context file for our component composition patterns"
• "Update the rules to reflect our new TypeScript strict mode requirement"

Support

The scaffold includes:

• rules/scaffold-agent-context.mdc - Detailed setup guide for the agent
• README.md - Documentation for developers
• Templates and examples for rules and context files

Installation Methods

NPM Package

npx cursor-agent-scaffold

Git Repository

git clone <repo-url>
cp -r cursor-agent-scaffold/* .cursor/

Zip File

Download and extract into .cursor/ folder

See SHARING.md for more distribution options.

Note: This scaffold is designed to work with Cursor's AI agent. The agent will read scaffold-agent-context.mdc and guide you through the setup process automatically.