How to Set Up Cursor MDC Files for Project Rules

steps

1. Navigate to Your Project Directory:

   • Open a terminal and navigate to the directory of your project where you want to create the .mdc files.
   bashCopy

   cd path/to/your/project

2. Create a New MDC File:

   • Use a text editor or integrated development environment (IDE) to create a file with the .mdc extension.

3. Add Metadata to the MDC File:

   • Include metadata at the top of the file to describe its purpose.
   yamlCopy

   ---
   name: Rule Name
   description: A brief description of this rule.
   ruleType: autoattach
   globs:
     - "**/*.ts"
   ---

4. Define Patterns and Actions:

   • Add detailed instructions or code templates for the AI to follow.
   yamlCopy

   patterns:
     - "const fetchData = async () => { ... }"
   actions:
     - name: "fetchData"
       description: "Standard template for asynchronous data fetching"
       code: |
         const fetchData = async () => {
           const response = await apiClient.get('/endpoint');
           return response.data;
         };

5. Document Good Practices and Validations:

   • Use the MDC file to describe best practices, actions, or validations specific to your project.
   yamlCopy

   validations:
     - "Use proper TypeScript types for API responses."
     - "Ensure actions are documented for clarity."

6. Save and Integrate The File:

   • Save the .mdc file. If you are using a version control system such as Git, ensure to commit it for team-wide usage.

7. Test the Rules:

   • Use Cursor to verify that the new rules are properly attached (manually or automatically) and guiding AI behavior as intended.