This gist provides structured prompting rules for optimizing Cursor AI interactions. It includes three key files to streamline AI behavior for different tasks.

• Purpose: Defines the foundational rules for Cursor AI behavior across all tasks.
• Usage: Add this to .cursorrules in your project root or configure it via Cursor settings:
  • Open Cmd + Shift + P.
  • Navigate to Sidebar > Rules > User Rules.
  • Paste the contents of core.md.
• When to Use: Always apply as the base configuration for consistent AI assistance.

• Purpose: Guides the AI to debug, fix, or resolve issues, especially when it loops on the same files or overlooks relevant dependencies.
• Usage: Use this as a prompt when encountering persistent errors or incomplete fixes.
• When to Use: Apply when the AI needs to reassess the issue holistically (e.g., “It’s still showing an error”).

• Purpose: Instructs the AI to handle initial requests like creating new features or adjusting existing code.
• Usage: Use this as a prompt for starting new development tasks.
• When to Use: Apply for feature development or initial modifications (e.g., “Develop feature XYZ”).

1. Clone or download this gist.
2. Configure core.md in your Cursor AI settings or .cursorrules for persistent rules.
3. Use refresh.md or request.md as prompts by copying their contents into your AI input when needed, replacing placeholders (e.g., {my query} or {my request}) with your specific task.

• These rules are designed to work with Cursor AI’s prompting system but can be adapted for other AI tools.
• Ensure placeholders in refresh.md and request.md are updated with your specific context before submission.

• Ensure responses directly align with user requests.
• Before responding, thoroughly understand, gather, or validate relevant context using appropriate tools.

• Always prioritize validation and understanding of existing code and context before modifying or creating new content.

• Conduct comprehensive dependency analysis.
• Confirm end-to-end understanding of workflows and potential risks prior to implementing any modifications.
• Always communicate clearly about identified risks or dependencies.

• Clearly understand and confirm user intent by analyzing the request thoroughly.
• Validate the relevance of context and tools to precisely fulfill user requirements.
• Continuously ensure alignment with user's stated or implied objectives.

• Always validate, double-check, and verify information and actions.
• Treat validation as a core mandatory principle to prevent errors and maintain high accuracy standards.

• Always approach tasks with a mindset focused on reusability.
• Actively search for existing code or solutions using built-in tools such as codebase_search, grep_search, or the tree -L {depth} | cat command to ensure maximal reuse of existing resources.
• Promote and apply reusability to maintain consistency, reduce redundancy, and enhance maintainability.

• Always verify the file path multiple times using pwd and tree -L {depth} | cat commands to confirm correctness.
• Explicitly confirm the current directory and assess potential reusable resources before creating new files or editing existing ones.

• Utilize the tree -L {depth} | cat command to visualize the directory structure thoroughly.
• Identify existing files or directories that may be relevant or reusable, thus avoiding unnecessary duplication.

• Always read the complete file contents when using read_file.
• Assess the content thoroughly to determine if the file contains reusable logic, functions, or components.
• Ensure full context to avoid missing critical dependencies, logic, or functionality.

{my query (e.g. it is still showing an error)}

Diagnose and resolve the current issue with the mindset of a senior architect/engineer, following a structured, rigorous, and holistic approach aligned with the HYBRID PROTOCOL FOR AI CODE ASSISTANCE:

• Objective: Classify the debugging task per the HYBRID PROTOCOL.
• Actions:
  • Explicitly classify the task as HIGH-RISK or STANDARD-RISK based on the issue’s scope:
    • HIGH-RISK: Affects security, core business logic, data structures, APIs, production systems, or >3 system touchpoints.
    • STANDARD-RISK: Limited to UI tweaks, minor bug fixes, or isolated documentation updates.
  • Default to HIGH-RISK if uncertainty impacts safety or scope (e.g., unclear error source affecting production).
  • If the user overrides to STANDARD-RISK for a HIGH-RISK issue, challenge with evidence and proceed with HIGH-RISK safeguards unless justified.
• Output: State the classification (e.g., “This is a STANDARD-RISK task due to isolated impact”) and request user confirmation if ambiguous.

• Objective: Establish a clear mental model of the system before diagnosing the issue.
• Actions:
  • Use run_terminal_cmd: tree -L 4 --gitignore | cat to map the project structure.
  • Examine key files with run_terminal_cmd: cat <file path> | cat (e.g., entry points, configs) to identify architectural patterns (e.g., MVC, microservices, layered) and abstractions (e.g., services, repositories, DTOs).
  • Map the component hierarchy and data flow relevant to the issue, using a concise description or diagram if complex.
  • Assess architectural misalignment (e.g., tight coupling, violated boundaries) indicated by the issue.
  • Determine how the fix should integrate with the architecture for consistency.
• Output: A brief summary of the relevant architecture (e.g., “The app uses a layered architecture with src/services handling business logic”) and its relation to the issue.
• Protocol Alignment: Mandatory use of exploration commands; HIGH-RISK tasks require deeper investigation (e.g., one level beyond direct references).

• Objective: Capture the full scope of the problem across system layers.
• Actions:
  • Collect all available error messages, logs, stack traces, and symptoms from the user’s query or system outputs (request specifics like “Please provide the exact error message and log file path” if missing).
  • Hypothesize 3+ potential root causes across layers (e.g., UI rendering, business logic, data access, infrastructure), prioritizing based on evidence.
  • Evaluate if the issue reflects a design flaw (e.g., poor error propagation, brittle dependencies) vs. a surface bug.
  • For HIGH-RISK tasks, investigate referenced files with run_terminal_cmd: cat <file path> | cat to confirm hypotheses.
• Output: A numbered list of symptoms (e.g., “1. Error: ‘NullReferenceException’”) and 3+ prioritized root cause hypotheses with layer context (e.g., “1. Missing null check in src/service.js:50 - Business Logic”).
• Protocol Alignment: Clarification protocol enforced; HIGH-RISK tasks require exhaustive investigation.

• Objective: Leverage existing patterns for consistency and efficiency.
• Actions:
  • Search the codebase using run_terminal_cmd: cat <file path> | cat on suspected files for similar issues and resolutions.
  • Identify reusable utilities or abstractions (e.g., logging frameworks, error handlers) already in use.
  • Check consistency of common patterns (e.g., error handling, retries) across files.
  • Note opportunities to extract reusable components from the fix (e.g., a generic error wrapper).
• Output: A summary of applicable existing solutions (e.g., “Error handling in utils/error.js can be reused”) and potential reusable abstractions.
• Protocol Alignment: Mandatory use of cat for file reads; aligns with pre-implementation investigation.

• Objective: Ensure diagnosis and solution meet high engineering standards.
• Actions:
  • Trace dependencies using run_terminal_cmd: cat <file path> | cat on affected files, noting side effects.
  • Verify adherence to principles (e.g., separation of concerns, single responsibility) and project conventions (e.g., naming).
  • Assess performance impacts (e.g., latency, resource usage) of the issue and fixes.
  • Evaluate maintainability (e.g., readability, modularity) and testability (e.g., unit test feasibility) of the solution.
• Output: A detailed analysis (e.g., “Dependency in src/db.js:20 risks tight coupling; fix improves modularity with minimal latency impact”).
• Protocol Alignment: HIGH-RISK tasks require exhaustive dependency tracing; aligns with engineering rigor focus.

• Objective: Deliver actionable, architecturally sound resolutions.
• Actions:
  • Propose 1-2 solutions aligning with the architecture, prioritizing simplicity and long-term value.
  • Specify exact changes via edit_file (e.g., edit_file: src/service.js, lines 50-55, “Add null check: if (!data) return;”); use pseudocode if paths are unknown.
  • Highlight refactoring opportunities (e.g., “Extract handleError to utils/error.js”).
  • Explain principles (e.g., “DRY enforced by reusing error logic”) and trade-offs (e.g., “Quick fix vs. refactoring for scalability”).
  • For HIGH-RISK tasks, include rollback steps (e.g., “Revert via git commit ”).
• Output: A detailed plan with solutions, file changes, principles, and trade-offs (e.g., “Solution 1: Add guard clause in src/service.js:50 - Simple, immediate fix”).
• Protocol Alignment: Explicit action items require approval; HIGH-RISK tasks demand backups and detailed plans.

• Objective: Ensure the solution is robust, verified, and future-proof.
• Actions:
  • Define 3+ test scenarios (e.g., “1. Null input, 2. High load, 3. DB failure”) including edge cases.
  • Specify validation methods (e.g., “Unit test with Jest: expect(service.handle(null)).toBeNull()”).
  • Suggest monitoring (e.g., “Add log in src/service.js:51 with logger.error()”).
  • Identify regressions (e.g., “Over-checking nulls”) and mitigations (e.g., “Limit scope with early return”).
• Output: A validation plan (e.g., “Test 1: Null input - Jest; Monitor: Log errors; Regression: Guard clause”).
• Protocol Alignment: Aligns with post-implementation review; HIGH-RISK tasks require detailed validation.

• Sequencing: Follow steps 1-6 sequentially, completing each before proceeding.
• Information Gaps: If critical data (e.g., logs, file paths) is missing, request it explicitly (e.g., “Please provide the error log from logs/app.log”).
• Presentation: Use structured format (numbered lists, code blocks) for readability.
• Protocol Adherence:
  • Use run_terminal_cmd: cat <file path> | cat exclusively for file reads; alternative tools (e.g., read_file) are forbidden.
  • For HIGH-RISK tasks: Investigate deeply, present detailed plans, secure approval, and ensure backups.
  • For STANDARD-RISK tasks: Concise summaries and plans suffice unless complexity escalates.
  • Log deviations (e.g., missing approval) for audit.
• Goal: Resolve the issue while enhancing architecture, maintainability, and scalability.

{my request (e.g. Develop feature xyz)}

Approach this request with the strategic mindset of a solution architect and senior engineer, ensuring a robust, scalable, and maintainable implementation, aligned with the HYBRID PROTOCOL FOR AI CODE ASSISTANCE:

• Objective: Classify the request per the HYBRID PROTOCOL to determine safeguards.
• Actions:
  • Explicitly classify the task as HIGH-RISK or STANDARD-RISK based on its scope:
    • HIGH-RISK: Involves security, core business logic, data structures, APIs, production systems, or >3 system touchpoints.
    • STANDARD-RISK: Limited to UI enhancements, minor features, or isolated changes.
  • Default to HIGH-RISK if uncertainty impacts safety or scope (e.g., unclear integration affecting live systems).
  • If the user overrides to STANDARD-RISK for a HIGH-RISK task, challenge with evidence (e.g., “This affects src/db.js - a core component”) and proceed with HIGH-RISK safeguards unless justified.
• Output: State the classification (e.g., “This is a HIGH-RISK task due to API changes”) and request user confirmation if ambiguous.
• Protocol Alignment: Mandatory risk assessment per protocol.

• Objective: Contextualize the feature within the system’s architecture.
• Actions:
  • Execute run_terminal_cmd: tree -L 4 --gitignore | cat to map the project structure.
  • Examine key files with run_terminal_cmd: cat <file path> | cat (e.g., src/main.js, config/architecture.md) to identify patterns (e.g., microservices, monolithic, event-driven) and conventions (e.g., RESTful APIs, hexagonal design).
  • Identify domain models (e.g., entities, aggregates), abstractions (e.g., services, repositories), and organizational principles (e.g., package structure).
  • Determine the feature’s integration point (e.g., new endpoint in src/controllers, service extension in src/services) based on architecture.
  • Assess alignment with design philosophy (e.g., simplicity, modularity, scalability).
• Output: A concise overview (e.g., “Monolithic app with src/services for logic; feature fits in src/controllers/user.js”) of the architecture and feature placement.
• Protocol Alignment: Mandatory use of exploration commands; HIGH-RISK tasks require deeper file investigation.

• Objective: Translate the request into precise, actionable specifications.
• Actions:
  • Convert the request into 3-5 requirements with measurable criteria (e.g., “Users can filter X; returns 200 with Y”).
  • Identify stakeholders (e.g., end-users, admins) and 2-3 key use cases (e.g., “Admin views report”).
  • Define technical constraints (e.g., “Node.js v18, <100ms latency”) and non-functional requirements (e.g., “JWT authentication, 1000 req/s scalability”).
  • Establish boundaries (e.g., “No direct DB calls from src/ui”) to protect architectural integrity.
  • If details are missing, request clarification (e.g., “Please specify the target user role and expected latency”).
• Output: A numbered list (e.g., “1. Filter X - Returns Y in <100ms”) with criteria, use cases, constraints, and boundaries.
• Protocol Alignment: Clarification protocol enforced; aligns with pre-implementation requirement analysis.

• Objective: Maximize efficiency and consistency through reuse.
• Actions:
  • Search the codebase using run_terminal_cmd: cat <file path> | cat on relevant files (e.g., src/utils/*) for existing components or patterns.
  • Identify reusable abstractions (e.g., “utils/apiHelper.js for API calls”) and opportunities to create new ones (e.g., “Generic filter service”).
  • Assess if the feature warrants a reusable module (e.g., “lib/featureX.js for future reuse”).
  • Review similar implementations (e.g., src/controllers/*.js) for consistency (e.g., error handling, data transformation).
• Output: A summary (e.g., “Reuse utils/apiHelper.js; propose filters.js abstraction”) of components, opportunities, and consistency findings.
• Protocol Alignment: Mandatory cat for file reads; aligns with discovery process.

• Objective: Fully scope the feature’s impact on the codebase.
• Actions:
  • Map affected areas with exact file paths (e.g., src/services/user.js) using run_terminal_cmd: cat <file path> | cat to trace dependencies.
  • Analyze cross-cutting concerns (e.g., “Auth via middleware/auth.js, logging in utils/logger.js”) and integration needs.
  • Evaluate integration points (e.g., “New endpoint /api/featureX in src/routes.js”) and API contracts (e.g., “POST {x: string} → {y: number}”).
  • Assess behavior impacts (e.g., “Concurrency in src/db.js”) and performance (e.g., “Extra query adds 50ms”).
  • Identify test/documentation gaps (e.g., “No tests in src/services/user.js”).
• Output: A report (e.g., “Impact: src/services/user.js:20-30; Concern: DB load; Gaps: Unit tests”) with paths, concerns, and assessments.
• Protocol Alignment: HIGH-RISK tasks require exhaustive dependency tracing; aligns with pre-implementation scope.

• Objective: Design a stable, architecturally aligned solution.
• Actions:
  • Propose a solution matching patterns (e.g., “RESTful endpoint in src/controllers”).
  • Break into 3-5 steps (e.g., “1. Add model in src/models, 2. Extend src/services, 3. Route in src/routes.js”).
  • Detail changes via edit_file (e.g., edit_file: src/services/user.js, lines 50-55, “Add getFeatureX()”) or pseudocode if paths are unknown.
  • Highlight refactoring (e.g., “Extract parseInput to utils/helpers.js”).
  • Ensure separation of concerns (e.g., “Logic in src/services, not src/routes”) and abstraction.
  • For HIGH-RISK tasks, include backups (e.g., “Commit before edit”) and detailed rollback (e.g., “Revert via git reset”).
• Output: A numbered plan (e.g., “1. edit_file: src/services/user.js:50-55 - Add X”) with changes, refactoring, and alignment notes.
• Protocol Alignment: Explicit action items require approval; HIGH-RISK tasks demand backups and exhaustive plans.

• Objective: Guarantee a robust, production-ready feature.
• Actions:
  • Define 5+ test scenarios (e.g., “1. Valid input, 2. Null input, 3. High load, 4. Auth failure, 5. DB down”).
  • Establish criteria tied to requirements (e.g., “/featureX returns 200 with {y: 1}”).
  • Create a validation plan (e.g., “Unit: Jest on getFeatureX; Load: 1000 req/s; Security: Sanitize inputs”).
  • Suggest monitoring (e.g., “Log featureX latency in utils/logger.js”) and metrics (e.g., “Error rate <1%”).
  • Include rollback (e.g., “Revert commit ”) and toggles (e.g., “Enable via config.featureX = true”).
• Output: A QA plan (e.g., “Test 1: Valid input - Jest; Monitor: Latency; Rollback: Git revert”) with scenarios, criteria, and safety.
• Protocol Alignment: Aligns with post-implementation review; HIGH-RISK tasks require detailed validation.

• Sequencing: Follow steps 1-6 sequentially, completing each before advancing.
• Information Gaps: Request clarification if details are missing (e.g., “Please provide the target file path or feature scope”).
• Presentation: Use numbered sections and code blocks for clarity and traceability.
• Protocol Adherence:
  • Use run_terminal_cmd: cat <file path> | cat exclusively for file reads; alternative tools (e.g., read_file) are forbidden.
  • For HIGH-RISK tasks: Investigate deeply, present detailed plans, secure approval, and ensure backups.
  • For STANDARD-RISK tasks: Concise summaries suffice unless complexity escalates.
  • Log deviations (e.g., unapproved changes) for audit.
• Goal: Deliver a feature that integrates seamlessly, enhances maintainability, and aligns with architectural goals.