Copilot instructions

1---
2description: Configuration for AI behavior when interacting with Codacy's MCP Server
3applyTo: '**'
4---
5 
6<!-- SPDX-License-Identifier: MIT -->
7<!-- SPDX-FileCopyrightText: 2025-2026 Marcus Quinn -->
8 
9# Codacy Rules
10 
11Configuration for AI behavior when interacting with Codacy's MCP Server
12 
13## CRITICAL: After ANY successful `edit_file` or `reapply` operation
14 
15- YOU MUST IMMEDIATELY run the `codacy_cli_analyze` tool from Codacy's MCP Server for each file that was edited, with:
16- `rootPath`: set to the workspace path
17- `file`: set to the path of the edited file
18- `tool`: leave empty or unset
19- If any issues are found in the new edits, propose and apply fixes for them.
20- > NOTE: Failure to follow this rule is considered a critical error.
21 
22## When you tried to run the `codacy_cli_analyze` tool and the Codacy CLI is not installed
23 
24- Ask the user 'Codacy CLI is not installed. Would you like me to install it now?'
25- If the user responds with "yes", run the `codacy_cli_install` tool and then continue with the original task
26- If the user responds with "no", instruct the user that they can disable automatic analysis in the extension settings
27- Wait for the user to respond before proceeding with any other actions
28 
29## After every response
30 
31- If you made any file edits in this conversation, verify you ran `codacy_cli_analyze` tool from Codacy's MCP Server
32 
33## When there are no Codacy MCP Server tools available, or the MCP Server is not reachable
34 
35- Suggest the user the following troubleshooting steps:
36- Try to reset the MCP on the extension
37- If the user is using VSCode, suggest them to review their Copilot > MCP settings in Github, under their organization or personal account. Refer them to Settings > Copilot > Enable MCP servers in Copilot. Suggested URL (https://github.com/settings/copilot/features) or https://github.com/organizations/{organization-name}/settings/copilot/features (This can only be done by their organization admins / owners)
38- If none of the above steps work, suggest the user to contact Codacy support
39 
40## Trying to call a tool that needs a rootPath as a parameter
41 
42- Always use the standard, non-URL-encoded file system path
43 
44## CRITICAL: Dependencies and Security Checks
45 
46- IMMEDIATELY after ANY of these actions:
47- Running npm/yarn/pnpm install
48- Adding dependencies to package.json
49- Adding requirements to requirements.txt
50- Adding dependencies to pom.xml
51- Adding dependencies to build.gradle
52- Any other package manager operations
53- You MUST run the `codacy_cli_analyze` tool with:
54- `rootPath`: set to the workspace path
55- `tool`: set to "trivy"
56- `file`: leave empty or unset
57- If any vulnerabilities are found because of the newly added packages:
58- Stop all other operations
59- Propose and apply fixes for the security issues
60- Only continue with the original task after security issues are resolved
61- EXAMPLE:
62- After: npm install react-markdown
63- Do: Run codacy_cli_analyze with trivy
64- Before: Continuing with any other tasks
65 
66## General
67 
68- Repeat the relevant steps for each modified file.
69- "Propose fixes" means to both suggest and, if possible, automatically apply the fixes.
70- You MUST NOT wait for the user to ask for analysis or remind you to run the tool.
71- Do not run `codacy_cli_analyze` looking for changes in duplicated code or code complexity metrics.
72- Complexity metrics are different from complexity issues. When trying to fix complexity in a repository or file, focus on solving the complexity issues and ignore the complexity metric.
73- Do not run `codacy_cli_analyze` looking for changes in code coverage.
74- Do not try to manually install Codacy CLI using either brew, npm, npx, or any other package manager.
75- If the Codacy CLI is not installed, just run the `codacy_cli_analyze` tool from Codacy's MCP Server.
76- When calling `codacy_cli_analyze`, only send provider, organization and repository if the project is a git repository.
77 
78## Whenever a call to a Codacy tool that uses `repository` or `organization` as a parameter returns a 404 error
79 
80- Offer to run the `codacy_setup_repository` tool to add the repository to Codacy
81- If the user accepts, run the `codacy_setup_repository` tool
82- Do not ever try to run the `codacy_setup_repository` tool on your own
83- After setup, immediately retry the action that failed (only retry once)
84