Workspace Rules

Workspace rules let you customize how the AI behaves in your project. These files are read automatically from your workspace root and included in every AI request.

Supported Rule Files#

MiraBridge supports multiple rule file formats (in priority order):

1. MIRABRIDGE.md — MiraBridge-specific rules (highest priority)
2. .cursorrules — Cursor AI rules (widely adopted format)
3. CLAUDE.md — Claude Code rules
4. .windsurfrules — Windsurf rules
5. .clinerules — Cline rules
6. copilot-instructions.md — GitHub Copilot instructions

Writing Effective Rules#

# MIRABRIDGE.md
 
## Project Overview
This is a NestJS monorepo with PostgreSQL and Redis.
 
## Coding Standards
- Use TypeScript strict mode
- All functions must have JSDoc comments
- Prefer composition over inheritance
 
## File Structure
- Controllers go in `src/controllers/`
- Services go in `src/services/`
- Tests go next to source files with `.spec.ts` suffix

Best Practices#

• Keep rules concise — they consume context tokens
• Focus on project-specific conventions the AI would not know
• Include file structure patterns and naming conventions
• Mention frameworks and libraries with their versions

Next Steps#

• Context & Prompts — how context is managed
• Settings — extension configuration