Skip to content

Commit cb0a9dc

Browse files
chore: update docs with new guardrails flow (#2486)
* update docs with new guardrails flow * resize images
1 parent 2078aa2 commit cb0a9dc

File tree

3 files changed

+9
-10
lines changed

3 files changed

+9
-10
lines changed

docs/codacy-guardrails/codacy-guardrails-getting-started.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -83,23 +83,22 @@ It will create a folder in your local repository called **.codacy** with all nee
8383
The IDE extension will ignore any CLI version already installed (e.g. through brew or other package manager) on the machine.
8484

8585

86-
### 3. Install MCP Server
86+
### 3. Check if the Codacy MCP Server is properly setup
8787

88-
#### a. Add the Codacy MCP Server
88+
Codacy MCP Server will be installed automatically when starting the extension, and an instructions file will be created in your workspace.
8989

90-
In the Codacy Extension tab, click **Add Codacy MCP Server**
90+
If you don't want Guardrails to automatically generate the instructions file, go to the extension's settings and set the instructions generation setting to manual.
9191

92-
![Add Codacy MCP Server](images/add-codacy-mcp-server.png)
92+
![Guardrails instructions setting](images/guardrails-instructions-setting.png)
9393

94-
#### b. Check if the Codacy MCP Server is enabled
94+
!!! warning
95+
The absence of the instructions file will impact the Guardrails experience.
9596

96-
On the left side menu of the Codacy extension, please make sure that MCP server is set up and ready.
97+
You can later generate the instructions manually from the Guardrails section of the extension.
9798

98-
![Codacy MCP Server is enabled](images/mcp-server-enabled.png)
99+
![Generate instructions file](images/guardrails-generate-instructions-file.png)
99100

100-
### 4. Restart your IDE
101-
102-
### 5. After everything is set up, you should now be able to interact with Codacy via AI chat.
101+
### 4. After everything is set up, you should now be able to interact with Codacy via AI chat.
103102
* Remember that for you to be able to interact with Codacy MCP server, you must be on the `Agent` mode of the chat, not the default `Ask` mode.
104103
* If you're still having issues with the MCP server, try to run the command `Preferences: Open User Settings (JSON)`, look for the Codacy MCP server settings and right on top of it you'll should see a `Start` option. Click on it and, if unsuccessful, go to `View > Debug Console` and check for errors. Don't forget to ensure you have `node.js` and `npx` installed and set up.
105104

71.5 KB
Loading
53.9 KB
Loading

0 commit comments

Comments
 (0)