Skip to content

Commit c16adab

Browse files
committed
update readme
1 parent 08b1cae commit c16adab

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,25 @@ This repository includes a sample file with a rule violation to demonstrate how
3333

3434
You can use an AI agent to scan this file and see the violation.
3535

36-
1. **Start the Context Sherpa server**:
37-
```bash
38-
./context-sherpa
36+
1. **Configure the MCP server** in your AI editor:
37+
Add the following to your `mcp.json` configuration file (assuming you built the binary as `server` or didn't otherwise specify a different output file name when running `go build`):
38+
```json
39+
{
40+
"mcpServers": {
41+
"context-sherpa": {
42+
"type": "stdio",
43+
"command": "./server"
44+
}
45+
}
46+
}
3947
```
4048

41-
2. **Instruct your AI agent to scan the file**:
49+
2. **Start your AI editor** with the MCP server configured.
50+
51+
3. **Instruct your AI agent to scan the file**:
4252
> "Scan the code in the `test-violation.go` file."
4353

44-
3. **The agent will use the `scan_code` tool and report the violation**:
54+
4. **The agent will use the `scan_code` tool and report the violation**:
4555
The agent will read the file and call the `scan_code` tool with the content of `test-violation.go`. The server will then return the violation found, and the agent will report it back to you.
4656

4757
## Tools

0 commit comments

Comments
 (0)