Skip to content

Commit 1b2d3cb

Browse files
fix vale issues
1 parent bcd8db7 commit 1b2d3cb

4 files changed

Lines changed: 24 additions & 24 deletions

File tree

docs/codacy-guardrails/codacy-guardrails-faq.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@
44
Please have a look at our [documentation](codacy-guardrails-getting-started.md)
55

66
## Does Guardrails only work with AI-generated code?
7-
No — while Guardrails does scan and auto-fix AI code as part of the agent flow, it scans any code shown in your IDE in real-time, regardless of how it was written.
7+
No. While Guardrails does scan and autofix AI code as part of the agent flow, it scans any code shown in your IDE in real-time, regardless of how it was written.
88

9-
## How is Guardrails different from Codacy’s traditional analysis?
9+
## How's Guardrails different from Codacy’s traditional analysis?
1010
Guardrails is IDE-first and real-time. It complements Codacy’s platform analysis by catching issues earlier in the development cycle.
1111

1212
## Does Guardrails work offline?
1313
Yes, local scanning via Codacy CLI works offline. API-based features (like querying metrics) require connectivity.
1414

1515
## Which AI security and quality standards can I enforce with Guardrails?
16-
Codacy Guardrails detects and auto-remediates security risks and quality issues in JavaScript, TypeScript, Python, and Java, including:
16+
Codacy Guardrails detects and autoremediates security risks and quality issues in JavaScript, TypeScript, Python, and Java, including:
1717

1818

1919
- SAST vulnerabilities
@@ -29,7 +29,7 @@ Codacy Guardrails detects and auto-remediates security risks and quality issues
2929
Configuring and enforcing coding standards at scale across all IDEs in your organization requires a Codacy Team or Business subscription.
3030

3131
## Is my data secure?
32-
Codacy Guardrails is not a large language model, but an IDE extension that uses an MCP Server to communicate with existing AI coding agents owned by the user.
32+
Codacy Guardrails isn't a large language model, but an IDE extension that uses an MCP Server to communicate with existing AI coding agents owned by the user.
3333

3434
## When I change some analysis configuration in the UI, is it automatically applied to Guardrails?
3535
We're still working on this feature but in order to update the new tool configuration. you should run the command in your repository:
@@ -50,7 +50,7 @@ Check our [Team and Organization plans](https://www.codacy.com/pricing) to unloc
5050

5151

5252
- Central configuration and enforcement of AI coding standards across teams and projects
53-
- Query and auto-fix existing problems across your codebase from the AI chat panel
53+
- Query and autofix existing problems across your codebase from the AI chat panel
5454
- Generate custom security and code quality reports using AI prompts
5555
- Full access to the Codacy Cloud platform including:
5656

@@ -65,6 +65,6 @@ Check our [Team and Organization plans](https://www.codacy.com/pricing) to unloc
6565
Guardrails is supported on MacOS, Linux, and Windows (via [WSL](https://learn.microsoft.com/en-us/windows/wsl/install))
6666

6767
## Can I use Guardrails without an AI copilot?
68-
Codacy Guardrails is designed to be installed from our IDE extension for VS Code, Cursor and Windsurf. but as long as you have an AI code generator that is compatible with the MCP protocol you can also add Guardrails into your MCP configuration manually.
68+
Codacy Guardrails is designed to be installed from our IDE extension for VS Code, Cursor and Windsurf. but as long as you have an AI code generator that's compatible with the MCP protocol you can also add Guardrails into your MCP configuration manually.
6969

7070
Without an AI coding agent, you instead need to use the Codacy IDE extension without the MCP Server.

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Besides real-time AI code scanning, Guardrails users can now prompt all their Co
4040
- ESLint
4141
- Pylint
4242
- PMD
43-
- DartAnalyzer
43+
- dartanalyzer
4444
- [Lizard](https://docs.codacy.com/release-notes/cloud/cloud-2025-02-adding-ruff-lizard/#lizard)
4545

4646
## How to install - Quick Guide
@@ -81,7 +81,7 @@ In the Codacy Extension tab, click **Add Codacy MCP Server**
8181

8282
#### b. Check if the Codacy MCP Server is enabled
8383

84-
On the left side menu of the Codacy extension, please make sure that mcp server is set up and ready.
84+
On the left side menu of the Codacy extension, please make sure that MCP server is set up and ready.
8585

8686
![Codacy MCP Server is enabled](images/mcp-server-enabled.png)
8787

@@ -104,7 +104,7 @@ brew install codacy/codacy-cli-v2/codacy-cli-v2
104104

105105
##### Linux
106106

107-
For Linux, we rely on the codacy-cli.sh script in the root. To download the CLI, run:
107+
For Linux, we rely on the **codacy-cli.sh** script in the root. To download the CLI, run:
108108

109109
```bash
110110
bash <(curl -Ls https://raw.githubusercontent.com/codacy/codacy-cli-v2/main/codacy-cli.sh)
@@ -191,12 +191,12 @@ Or open the general settings.json file directly, which according to your OS shou
191191

192192
Make sure you update the value of `CODACY_ACCOUNT_TOKEN` with your [API token](../codacy-api/api-tokens.md).
193193

194-
a. Above the MCP Server configuration in **Settings.json** file, you can Click in the command **Start**
194+
a. Above the MCP Server configuration in **Settings.json** file, you can Click in the command **Start**
195195

196196
![Start MCP Server in VSCode](images/start-mcp-server-vscode.png)
197197

198-
b. Make sure you have Agent mode enabled: [vscode://settings/chat.agent.enabled](vscode://settings/chat.agent.enabled)
198+
b. Make sure you have Agent mode enabled: [vscode://settings/chat.agent.enabled](vscode://settings/chat.agent.enabled)
199199

200-
c. Open the Copilot chat and switch the mode to `Agent`. You can check that the MCP server was enabled correctly by clicking on the `Select tools` icon, which should list all the available Codacy tools.
200+
c. Open the Copilot chat and switch the mode to `Agent`. You can check that the MCP server was enabled correctly by clicking on the `Select tools` icon, which should list all the available Codacy tools.
201201

202202
![Copilot Agent with Codacy tools](images/copilot_agent.png)

docs/codacy-guardrails/codacy-guardrails-how-to-configure-rules.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ However, when an API token is used, Codacy automatically retrieves the current r
77
You can configure your rules in one of two ways:
88

99

10-
- Using [built-in scanner configuration files](#using-configuration-files)for version-controlled setups.
10+
- Using [built-in scanner configuration files](#using-configuration-files)for version-controlled setups.
1111

12-
- Using the [Codacy UI](#using-the-codacy-ui)for quick, manual adjustments.
12+
- Using the [Codacy UI](#using-the-codacy-ui)for quick, manual adjustments.
1313

1414
!!! note
1515
If you're already using a configuration file, please we recommend you can follow the first way. Otherwise, the second way is the best for you, so you can configure directly in the Codacy platform.
@@ -132,5 +132,5 @@ Select the coding standards that you want to follow or stop following and click
132132
![Customize applied coding standards](images/code-patterns-cs-customize-modal.png)
133133

134134
!!! note
135-
- Scanners and rules enabled by a coding standard are enforced and cannot be disabled.
136-
- You can add extra scanners and rules, if these are not enabled by any applied coding standard.
135+
- Scanners and rules enabled by a coding standard are enforced and can't be disabled.
136+
- You can add extra scanners and rules, if these aren't enabled by any applied coding standard.

docs/codacy-guardrails/codacy-guardrails-how-to-use.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Write secure, compliant AI code
44

5-
a. Let's run an prompt to create a webserver in Java
5+
a. Let's run an prompt to create a webserver in Java
66

77
```text
88
Create a lightweight webserver in Java.
@@ -14,15 +14,15 @@ In response, it generated a compact, readable Java class using ServerSocket and
1414

1515
![response to the webserver creation using AI](images/response-webserver.png)
1616

17-
b. There's a call from MCP tool to analyse the code that was generated. Click in **Run tool**
17+
b. There's a call from MCP tool to analyse the code that was generated. Click in **Run tool**
1818

19-
Codacy Guardrails starts analyzing it automatically using the Codacy CLI embedded in the agent’s flow. No configs, no extra stepsit just works.
19+
Codacy Guardrails starts analyzing it automatically using the Codacy CLI embedded in the agent’s flow. No configurations, no extra stepsit just works.
2020

21-
It found an issue with PMD - the package name is not correctly declared - and it will try to fix that with the right declaration.
21+
It found an issue with PMD - the package name isn't correctly declared - and it will try to fix that with the right declaration.
2222

2323
![analysis to the webserver implementation](images/analysis-webserver-implementation.png)
2424

25-
c. After a new analysis, It shows us that it has 0 issues in the code
25+
c. After a new analysis, It shows us that it has 0 issues in the code
2626

2727
![zero issues in the webserver implementation](images/no-issues-webserver.png)
2828

@@ -31,7 +31,7 @@ c. After a new analysis, It shows us that it has 0 issues in the code
3131
Once your repository is connected to Codacy, you can go beyond traditional static analysis and start interacting with your codebase using simple natural language prompts.
3232

3333

34-
a. Let's run a quick example with the prompt:
34+
a. Let's run a quick example with the prompt:
3535

3636
```text
3737
Can you list all security issues in my repository?
@@ -40,12 +40,12 @@ Can you list all security issues in my repository?
4040
![Prompt list the security issues in my repository](images/prompt-list-security-issues-repository.png)
4141

4242

43-
b. Right after running this prompt, there is a MCP tool call to search all security issues in my repository. Click in **Run tool**
43+
b. Right after running this prompt, there is a MCP tool call to search all security issues in my repository. Click in **Run tool**
4444

4545
![List the security issues in my repository](images/run-mcp-tool-list-security-issues.png)
4646

4747
It will search for all open security issues in my repository. And it will list all of them, showing the **title**, **priority**, **status** and the **link to the issue**,
4848

4949
![List the security issues in my repository](images/list-security-issues.png)
5050

51-
It turned security from a checklist into a dialogueand that changes everything.
51+
It turned security from a checklist into a dialogueand that changes everything.

0 commit comments

Comments
 (0)