Cursor Rules Repository

A comprehensive collection of standardized Cursor rules following the official Project Rules format. These project-agnostic rules provide consistent AI assistant behavior across all development work.

🏗️ Project Structure

Following the official Cursor documentation, rules are organized as Project Rules in .cursor/rules/ with proper MDC (Metadata Document Content) format:

cursorrules/
├── README.md                 # This documentation
├── .cursor/rules/            # Project Rules (MDC)
│   ├── effective_kotlin.mdc  # Kotlin guidelines (auto-attaches to *.kt, *.kts)
│   ├── effective_go.mdc      # Go guidelines (auto-attaches to *.go)
│   ├── effective_rust.mdc    # Rust guidelines (auto-attaches to *.rs)
│   ├── git.mdc               # Git workflows
│   ├── github.mdc            # GitHub collaboration rules
│   └── notion.mdc            # Notion documentation rules
├── scripts/
│   ├── setup.sh
│   ├── install-mcp-config.sh
│   └── update.sh
├── mcp.json                  # MCP server configuration
└── USAGE.md                  # Detailed usage instructions

🎯 Rule Categories

Auto-Attached Language Rules

• effective_kotlin.mdc – Kotlin guidelines (auto-attaches to *.kt, *.kts)
• effective_go.mdc – Go guidelines (auto-attaches to *.go)
• effective_rust.mdc – Rust guidelines (auto-attaches to *.rs)

Platform & Workflow Rules

• git.mdc – Git version-control workflows
• github.mdc – GitHub collaboration & community guidelines

Agent-Requested Rules

• notion.mdc – Notion documentation & knowledge management

🔧 MCP Server Integration

Your ~/.cursor/mcp.json includes 5 configured MCP servers for enhanced functionality:

• 🌐 Puppeteer - Web automation and browser interaction
• 🧠 Sequential Thinking - Advanced reasoning and problem-solving
• 🔍 Brave Search - Real-time web search capabilities
• 🐙 GitHub - Repository management and collaboration (via Docker)
• ⚡ Git - Version control operations

Security Features

• 🔐 1Password Integration - Secure API key management for GitHub and Brave Search
• 🐳 Docker Containerization - GitHub MCP server runs in isolated container
• 🔒 Token Isolation - No hardcoded credentials in configuration

🚀 Quick Start

Install Project Rules

# Clone the repository
git clone https://github.com/yourusername/cursorrules.git

# Install Project Rules to your project
cd your-project
bash /path/to/cursorrules/scripts/setup.sh

Install MCP Configuration

# Install MCP server configuration
bash scripts/install-mcp-config.sh

📖 How It Works

Following the official Cursor documentation:

Rule Types

• Always Applied: base.mdc provides core principles for all contexts
• Auto-Attached: Rules automatically apply when relevant files are in context
• Agent Requested: AI decides when to apply based on context and description
• Manual: Apply explicitly using @ruleName in Cursor

MDC Format

Each rule uses MDC front-matter for configuration:

---
description: Rule description for AI context
globs: ["**/*.kt", "**/*.kts"]  # File patterns for auto-attachment
alwaysApply: false                 # Whether to always include
---

Rule Hierarchy

• Global rules apply to all contexts
• File-specific rules auto-attach based on globs patterns
• Agent-requested rules activate based on relevance
• Manual rules require explicit invocation

🛠️ Usage

In Cursor

• Rules auto-attach based on file context
• Use @ruleName to manually apply specific rules
• View active rules in Cursor Settings > Rules
• Generate new rules with /Generate Cursor Rules command

Update Rules

# Update existing installations
bash scripts/update.sh

Customize for Your Team

1. Fork this repository
2. Modify rules in .cursor/rules/ to match your standards
3. Update mcp.json with your API keys and preferences
4. Share the fork with your team

🎨 Features

Language Support

• Kotlin: Comprehensive "Effective Kotlin" guidelines with auto-attachment
• Go: Effective Go guidelines with auto-attachment
• Rust: Effective Rust guidelines with auto-attachment

Integration Support

• GitHub: Platform features, Actions, PR guidelines, open source contribution workflow
• Notion: Documentation and knowledge management

📚 Learn More

• Official Cursor Rules Documentation
• MDC Format Guide
• Best Practices
• USAGE.md - Detailed usage instructions and examples

🤝 Contributing

1. Fork the repository
2. Create feature branch following git conventions
3. Update relevant .mdc files in .cursor/rules/
4. Test rules in a sample project
5. Submit PR with clear description

📄 License

MIT License - Use freely in personal and commercial projects.