Skip to content

Commit 48e10f4

Browse files
committed
README update
1 parent 9f7c2b3 commit 48e10f4

File tree

2 files changed

+20
-1
lines changed

2 files changed

+20
-1
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -172,3 +172,22 @@ After global installation, you can use the `socket-mcp` command from anywhere:
172172
export SOCKET_API_KEY=your_api_key_here
173173
socket-mcp
174174
```
175+
176+
## Adjust tool usage with custom rules
177+
178+
You can further customize how the Socket MCP server interacts with your AI assistant by modifying your client rules. The rules are usually a markdown file and its location depends on the AI assistant you are using.
179+
180+
| MCP Client | Rules File Location |
181+
|---|---|
182+
| Claude Desktop/Code | `CLAUDE.md` |
183+
| VSCode Copilot | `.github/copilot-instructions.md` |
184+
| Cursor | `.cursor/rules` |
185+
186+
187+
Rules that can be added to the client rules file include the following:
188+
189+
```md
190+
Always check dependency scores with the debscore tool when you add a new dependency. If the score is low, consider using an alternative library or writing the code yourself. If you are unsure about the score, ask for a review from someone with more experience. When checking dependencies, make sure to also check the imports not just the pyproject.toml file.
191+
```
192+
193+
You can adjust the rules to fit your needs. For example, you can add rules to include specific manifest files, or guide the AI assistant on how to handle low scores. The rules are flexible and can be tailored to your workflow.

src/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ const server = new McpServer({
4646

4747
server.tool(
4848
"depscore",
49-
"Get the dependency score of a package with the `depscore` tool from Socket. Use 'unknown' for version if not known. Use this tool to scan dependencies for their quality and security on existing code or when code is generated. Stop generating code and ask the user how to proceed when any of the scores are low.",
49+
"Get the dependency score of a package with the `depscore` tool from Socket. Use 'unknown' for version if not known. Use this tool to scan dependencies for their quality and security on existing code or when code is generated. Stop generating code and ask the user how to proceed when any of the scores are low. When checking dependencies, make sure to also check the imports in the code, not just the manifest files (pyproject.toml, package.json, etc).",
5050
{
5151
ecosystem: z.string().describe("The package ecosystem (e.g., npm, pypi)").default("npm"),
5252
depname: z.string().describe("The name of the dependency"),

0 commit comments

Comments
 (0)