Skip to content

Commit bcf0eda

Browse files
authored
docs: Update the README and add dev page (#13)
Update the README with clearer install steps Add a development readme for people who help Signed-off-by: Owen Rumney <owen.rumney@aquasec.com>
1 parent 1fc65bf commit bcf0eda

File tree

2 files changed

+53
-20
lines changed

2 files changed

+53
-20
lines changed

DEVELOPMENT.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Local Development
2+
3+
These steps should get you up and running while the development is being done
4+
5+
## Prereqs
6+
7+
- Go (1.24.1)
8+
- make
9+
- Trivy installed
10+
11+
## Installing the Trivy Plugin
12+
13+
Normally, when installing a Trivy plugin you would do `trivy plugin install <pluginName>`, as this isn't a public repo just yet, we need to do it manually for now.
14+
15+
1. Create the plugin path and setup the manifest file
16+
```sh
17+
make add-plugin-manifest
18+
```
19+
2. Install the plugin
20+
```ssh
21+
make install-plugin
22+
```
23+
24+
## Run the MCP Server
25+
26+
You can now run the MCP Server using
27+
28+
```sh
29+
trivy mcp
30+
```
31+
32+
Return to the instructions on [configuring VSCode](README.md#configuring-the-mcp-server-in-vscode) in the [README.md](README.md)

README.md

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,30 +3,17 @@
33
This plugin starts an MCP Server that can be used as a gateway to Trivy
44

55
> [!IMPORTANT]
6-
> This is early stage development of the MCP Server, so some setup is required and you should assume things won't work great for now
6+
> This is early stage development of the MCP Server, so you should assume things won't work great for now
77
8-
# Local Development
8+
## Installing the plugin
99

10-
These steps should get you up and running while the development is being done
10+
To install the plugin you can use Trivy's plugin management system
1111

12-
## Prereqs
13-
14-
- Go (1.24.1)
15-
- make
16-
- Trivy installed
17-
18-
## Installing the Trivy Plugin
19-
20-
Normally, when installing a Trivy plugin you would do `trivy plugin install <pluginName>`, as this isn't a public repo just yet, we need to do it manually for now.
12+
```sh
13+
trivy plugin install mcp
14+
```
2115

22-
1. Create the plugin path and setup the manifest file
23-
```sh
24-
make add-plugin-manifest
25-
```
26-
2. Install the plugin
27-
```ssh
28-
make install-plugin
29-
```
16+
The will install the latest version of the plugin
3017

3118
## Starting the plugin
3219

@@ -65,6 +52,20 @@ Now, we need to configure the server in VSCode to start using as an agent
6552
7. The settings.json should open
6653
8. Find the new server, there will be an annotation to `Start`
6754

55+
Your `mcp` block in the `settings.json` should look something like this;
56+
57+
```json
58+
"mcp": {
59+
60+
"servers": {
61+
"my-mcp-server-abd8d2de": {
62+
"type": "sse",
63+
"url": "http://localhost:23456/sse"
64+
}
65+
}
66+
},
67+
```
68+
6869

6970
## Some sample prompts
7071

0 commit comments

Comments
 (0)