Skip to content

Commit d316a80

Browse files
jackryan-snykgitbook-bot
authored andcommitted
GITBOOK-9958: NE-DNM-factory-change-install
1 parent 83f4a53 commit d316a80

File tree

10 files changed

+28
-20
lines changed

10 files changed

+28
-20
lines changed

docs/.gitbook/assets/image (1).png

-65.3 KB
Loading

docs/.gitbook/assets/image (2).png

23.6 KB
Loading
90.4 KB
Loading
90.4 KB
Loading

docs/.gitbook/assets/image.png

-69.3 KB
Loading

docs/integrations/developer-guardrails-for-agentic-workflows/quickstart-guides-for-mcp/cursor-guide.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Cursor guide
22

3-
You can access Snyk Studio, including Snyk's MCP server, in Cursor to secure code generated with agentic workflows through an LLM. This can be achieved in several ways. For most users, we recommend accessing Snyk Studio using the Snyk Security plugin. 
3+
You can access Snyk Studio, including Snyk's MCP server, in Cursor to secure code generated with agentic workflows through an LLM. This can be achieved in several ways. For most users, we recommend accessing Snyk Studio using the Snyk Security plugin.
44

55
## Recommended: Access Snyk Studio using the Snyk Security Plugin
66

@@ -13,7 +13,7 @@ You can access Snyk Studio, including Snyk's MCP server, in Cursor to secure cod
1313

1414
Once installation completes, a modal window will appear prompting an opt-in to Snyk Studio's "Secure at Inception." This will automatically configure the necessary rules to scan any new AI generated code. Additional variations are available within the plugin's Settings page.
1515

16-
<figure><img src="../../../.gitbook/assets/image.png" alt=""><figcaption></figcaption></figure>
16+
<figure><img src="../../../.gitbook/assets/image (41).png" alt=""><figcaption></figcaption></figure>
1717

1818
### Authenticate
1919

@@ -28,15 +28,15 @@ _For new users_, select the preferred sign up method and agree to the terms on t
2828

2929
**Please note:** In order to use Snyk Studio, specifically Snyk's SAST scanning capabilities, you'll need to enable [Snyk Code](../../../scan-with-snyk/snyk-code/). Snyk Code analyzes your code for vulnerabilities and temporarily clones the repository and/or uploads your code. Cloned or uploaded code is cached according to our [data retention policy](../../../snyk-data-and-governance/how-snyk-handles-your-data.md). With the Snyk Free Plan, Snyk Code offers unlimited scans for open source projects, and limited tests for 1st-party code. [More details on plans](https://snyk.io/plans/)
3030

31-
_For existing users,_ select the log-in method associated with your account. If you don't already have access to Snyk Code, your LLM will prompt you to enable it prior to your first scan. You can also [enable it directly in Snyk's Settings](../../../implementation-and-setup/enterprise-implementation-guide/phase-2-configure-account/set-visibility-and-configure-an-organization-template/enable-snyk-code.md).&#x20;
31+
_For existing users,_ select the log-in method associated with your account. If you don't already have access to Snyk Code, your LLM will prompt you to enable it prior to your first scan. You can also [enable it directly in Snyk's Settings](../../../implementation-and-setup/enterprise-implementation-guide/phase-2-configure-account/set-visibility-and-configure-an-organization-template/enable-snyk-code.md).
3232

3333
**Please note:** If you are enabling Snyk Code for the first time, you must import / re-import existing projects in order to properly scan them.
3434

3535
### Run Snyk Studio
3636

37-
Once authenticated, Snyk Studio should be triggered whenever new code is generated by the LLM. If Snyk Studio is not enabled, restart your IDE and try generating code again.&#x20;
37+
Once authenticated, Snyk Studio should be triggered whenever new code is generated by the LLM. If Snyk Studio is not enabled, restart your IDE and try generating code again.
3838

39-
**Please note:** Free users are limited to a set number of scans. If you reach the allotment, we recommend [reaching out to sales](https://snyk.io/contact-us/) to unlock additional thresholds.&#x20;
39+
**Please note:** Free users are limited to a set number of scans. If you reach the allotment, we recommend [reaching out to sales](https://snyk.io/contact-us/) to unlock additional thresholds.
4040

4141
## Alternate: Install Snyk Studio Directly
4242

docs/integrations/developer-guardrails-for-agentic-workflows/quickstart-guides-for-mcp/github-copilot-guide.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ You can access Snyk Studio, including Snyk's MCP server, in VSCode to secure cod
1313

1414
Once installation completes, a modal window will appear prompting an opt-in to Snyk Studio's "Secure at Inception." This will automatically configure the necessary rules to scan any new AI generated code. Additional variations are available within the plugin's Settings page.
1515

16-
<figure><img src="../../../.gitbook/assets/image (1).png" alt=""><figcaption></figcaption></figure>
16+
<figure><img src="../../../.gitbook/assets/image (45).png" alt=""><figcaption></figcaption></figure>
1717

1818
### Authenticate
1919

@@ -28,15 +28,15 @@ _For new users_, select the preferred sign up method and agree to the terms on t
2828

2929
**Please note:** In order to use Snyk Studio, specifically Snyk's SAST scanning capabilities, you'll need to enable [Snyk Code](../../../scan-with-snyk/snyk-code/). Snyk Code analyzes your code for vulnerabilities and temporarily clones the repository and/or uploads your code. Cloned or uploaded code is cached according to our [data retention policy](../../../snyk-data-and-governance/how-snyk-handles-your-data.md). With the Snyk Free Plan, Snyk Code offers unlimited scans for open source projects, and limited tests for 1st-party code. [More details on plans](https://snyk.io/plans/)
3030

31-
_For existing users,_ select the log-in method associated with your account. If you don't already have access to Snyk Code, your LLM will prompt you to enable it prior to your first scan. You can also [enable it directly in Snyk's Settings](../../../implementation-and-setup/enterprise-implementation-guide/phase-2-configure-account/set-visibility-and-configure-an-organization-template/enable-snyk-code.md).&#x20;
31+
_For existing users,_ select the log-in method associated with your account. If you don't already have access to Snyk Code, your LLM will prompt you to enable it prior to your first scan. You can also [enable it directly in Snyk's Settings](../../../implementation-and-setup/enterprise-implementation-guide/phase-2-configure-account/set-visibility-and-configure-an-organization-template/enable-snyk-code.md).
3232

3333
**Please note:** If you are enabling Snyk Code for the first time, you must import / re-import existing projects in order to properly scan them.
3434

3535
### Run Snyk Studio
3636

37-
Once authenticated, Snyk Studio should be triggered whenever new code is generated by the LLM. If Snyk Studio is not enabled, restart your IDE and try generating code again.&#x20;
37+
Once authenticated, Snyk Studio should be triggered whenever new code is generated by the LLM. If Snyk Studio is not enabled, restart your IDE and try generating code again.
3838

39-
**Please note:** Free users are limited to a set number of scans. If you reach the allotment, we recommend [reaching out to sales](https://snyk.io/contact-us/) to unlock additional thresholds.&#x20;
39+
**Please note:** Free users are limited to a set number of scans. If you reach the allotment, we recommend [reaching out to sales](https://snyk.io/contact-us/) to unlock additional thresholds.
4040

4141
## Alternate: Install Snyk Studio Directly
4242

docs/integrations/developer-guardrails-for-agentic-workflows/quickstart-guides-for-mcp/windsurf-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Access [Snyk Studio](../../../discover-snyk/getting-started/glossary.md#snyk-stu
1313

1414
Once installation completes, a modal will appear prompting you to opt-in to Snyk Studio's "[Secure at Inception](../../../discover-snyk/getting-started/glossary.md#secure-at-inception)." This will automatically configure the necessary rules to scan any new AI generated code. Additional variations are available within the plugin's **Settings** page.
1515

16-
<figure><img src="../../../.gitbook/assets/image (1).png" alt=""><figcaption></figcaption></figure>
16+
<figure><img src="../../../.gitbook/assets/image (45).png" alt=""><figcaption></figcaption></figure>
1717

1818
### Authenticate
1919

docs/integrations/snyk-studio-agentic-integrations/quickstart-guides-for-snyk-studio/factory-terminal-ide-guide.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,28 @@
11
# Factory Terminal/IDE guide
22

3-
Access Snyk Studio, including Snyk's MCP server, in Factory Terminal/IDE to secure code generated with agentic workflows through an LLM. You can achieve this by installing Snyk Studio directly.&#x20;
3+
Access Snyk Studio, including Snyk's MCP server, in Factory Terminal/IDE to secure code generated with agentic workflows through an LLM. You can achieve this by installing Snyk Studio directly.
44

55
### Install Factory Terminal/IDE
66

77
Install Factory Droid to your local machine from the [Factory website](https://docs.factory.ai/cli/getting-started/quickstart).
88

99
### Install Snyk Studio
1010

11-
Open a Droid session on your terminal. There are slash commands for MCP with droid. Enter the following to add Snyk Studio:
11+
Add the Snyk entry to `~/.factory/mcp.json`. To learn more, visit the official [Factory documentation](https://docs.factory.ai/cli/configuration/mcp#configuration) for more information.
1212

1313
```
14-
/mcp add Snyk "npx -y snyk@latest mcp -t stdio"
14+
{
15+
"mcpServers": {
16+
"Snyk": {
17+
"command": "npx",
18+
"args": ["-y", "snyk@latest", "mcp", "-t", "stdio"],
19+
"env": {}
20+
}
21+
}
22+
}
1523
```
1624

17-
<figure><img src="../../../.gitbook/assets/image (52).png" alt=""><figcaption><p>Open Droid session</p></figcaption></figure>
25+
<div align="left"><figure><img src="../../../.gitbook/assets/image (2).png" alt=""><figcaption></figcaption></figure></div>
1826

1927
### Authenticate
2028

@@ -27,28 +35,28 @@ As a one-time setup, authenticate and trust the Project directory. If required,
2735
If you are a new user, select the preferred sign-up method and agree to the terms on the next screen. After authentication, return to your Terminal/IDE.
2836

2937
{% hint style="info" %}
30-
To use Snyk Studio, specifically the SAST scanning capabilities, you must enable [Snyk Code](../../../scan-with-snyk/snyk-code/).&#x20;
38+
To use Snyk Studio, specifically the SAST scanning capabilities, you must enable [Snyk Code](../../../scan-with-snyk/snyk-code/).
3139

32-
Snyk Code analyzes your code for vulnerabilities, temporarily clones the repository, and uploads your code. Cloned or uploaded code is cached according to the Snyk [data retention policy](../../../snyk-data-and-governance/how-snyk-handles-your-data.md).&#x20;
40+
Snyk Code analyzes your code for vulnerabilities, temporarily clones the repository, and uploads your code. Cloned or uploaded code is cached according to the Snyk [data retention policy](../../../snyk-data-and-governance/how-snyk-handles-your-data.md).
3341

3442
With the Snyk Free Plan, Snyk Code offers unlimited scans for Open Source Projects, and limited tests for first-party code. To learn more about our available plans, visit [Plans and Pricing](https://snyk.io/plans/).
3543
{% endhint %}
3644

37-
For existing user&#x73;_,_ select the login method associated with your account. If you do not already have access to Snyk Code, your LLM prompts you to enable it prior to your first scan. You can also enable it directly in the Snyk settings. See [Enable Snyk Code](../../../implementation-and-setup/enterprise-implementation-guide/phase-2-configure-account/set-visibility-and-configure-an-organization-template/enable-snyk-code.md).
45+
For existing user&#x73;_,_ select the login method associated with your account. If you do not already have access to Snyk Code, your LLM prompts you to enable it prior to your first scan. You can also enable it directly in the Snyk settings. To learn more, visit [Enable Snyk Code](../../../implementation-and-setup/enterprise-implementation-guide/phase-2-configure-account/set-visibility-and-configure-an-organization-template/enable-snyk-code.md).
3846

3947
### Run Snyk Studio
4048

4149
On authentication, Snyk Studio is triggered whenever new code is generated by the LLM. If Snyk Studio is not enabled, restart your Terminal or IDE and try generating code again.
4250

4351
{% hint style="info" %}
44-
Free users are limited to a set number of scans. If you reach the allotment, Snyk recommends contacting the Snyk sales team for additional thresholds.&#x20;
52+
Free users are limited to a set number of scans. If you reach the allotment, Snyk recommends contacting the Snyk sales team for additional thresholds.
4553
{% endhint %}
4654

4755
## Setting up the Snyk MCP Server
4856

4957
As a one-time setup, you must trust the current Project directory. If required, the agentic workflow manages this automatically.
5058

51-
These workflows are automatically executed by the underlying model and the agentic code assistant, and you will need to approve them in the Droid product.&#x20;
59+
These workflows are automatically executed by the underlying model and the agentic code assistant, and you will need to approve them in the Droid product.
5260

5361
## Examples
5462

0 commit comments

Comments
 (0)