Skip to content

Commit 058a381

Browse files
committed
rename the binary to socket-mcp
1 parent 2cf3a33 commit 058a381

File tree

3 files changed

+15
-17
lines changed

3 files changed

+15
-17
lines changed

README.md

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,6 @@ The `depscore` tool allows AI assistants to query the Socket API for dependency
1414
- `depname`: The name of the dependency.
1515
- `version`: The version of the dependency. Defaults to "unknown".
1616

17-
**Example usage:**
18-
19-
```text
20-
depscore("npm", "express", "4.18.2")
21-
```
22-
2317
## Configuration
2418

2519
### Getting an API key
@@ -29,6 +23,9 @@ To use the Socket MCP Server, you need to create an API key. You can do this by
2923

3024
### Usage with Claude Desktop
3125

26+
> [!NOTE]
27+
> Custom integrations are not available to all paid versions of Claude. Check [here](https://support.anthropic.com/en/articles/11175166-about-custom-integrations-using-remote-mcp) for more information.
28+
3229
To use this MCP server with Claude Desktop:
3330

3431
1. Install the Socket MCP server:
@@ -43,11 +40,11 @@ To use this MCP server with Claude Desktop:
4340
export SOCKET_API_KEY=your_api_key_here
4441
```
4542

46-
3. In Claude Desktop, go to Settings > Assistants > Add Custom Tool.
43+
3. In Claude Desktop, go to Settings > Integrations > Add Custom Integration.
4744

4845
4. Enter the following:
4946
- Name: Socket
50-
- Command: `depscore`
47+
- Command: `socket-mcp`
5148
- Save the configuration.
5249

5350
5. Now you can ask Claude questions like "Check the security score for express version 4.18.2".
@@ -57,7 +54,7 @@ To use this MCP server with Claude Desktop:
5754
For quick installation, you can use the following link to install the Socket MCP server in VS Code:
5855

5956

60-
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Socket_MCP-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](vscode:mcp/install?%7B%22name%22%3A%22socket-mcp%22%2C%22inputs%22%3A%5B%7B%22type%22%3A%22promptString%22%2C%22id%22%3A%22socket_api_key%22%2C%22description%22%3A%22Socket%20API%20Key%22%2C%22password%22%3Atrue%7D%5D%2C%22command%22%3A%22depscore%22%2C%22type%22%3A%22stdio%22%2C%22env%22%3A%7B%22SOCKET_API_KEY%22%3A%22%24%7Binput%3Asocket_api_key%7D%22%7D%7D)
57+
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Socket_MCP-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](vscode:mcp/install?%7B%22name%22%3A%22socket-mcp%22%2C%22inputs%22%3A%5B%7B%22type%22%3A%22promptString%22%2C%22id%22%3A%22socket_api_key%22%2C%22description%22%3A%22Socket%20API%20Key%22%2C%22password%22%3Atrue%7D%5D%2C%22command%22%3A%22socket-mcp%22%2C%22type%22%3A%22stdio%22%2C%22env%22%3A%7B%22SOCKET_API_KEY%22%3A%22%24%7Binput%3Asocket_api_key%7D%22%7D%7D)
6158

6259

6360
To use this MCP server in VS Code:
@@ -83,7 +80,7 @@ To use this MCP server in VS Code:
8380
"servers": {
8481
"socket-mcp": {
8582
"type": "stdio",
86-
"command": "depscore",
83+
"command": "socket-mcp",
8784
"args": [],
8885
"env": {
8986
"SOCKET_API_KEY": "${input:socket_api_key}"
@@ -128,7 +125,7 @@ To build the project:
128125
npm run build
129126
```
130127

131-
This compiles the TypeScript files and makes the binary executable called `depscore`.
128+
This compiles the TypeScript files and makes the binary executable called `socket-mcp`.
132129

133130
## Run
134131

@@ -143,20 +140,20 @@ After installing globally, you can run the executable directly:
143140

144141
```bash
145142
export SOCKET_API_KEY=your_api_key_here
146-
depscore
143+
socket-mcp
147144
```
148145

149146
### Global Installation
150147

151-
To install the tool globally and make the `depscore` command available system-wide:
148+
To install the tool globally and make the `socket-mcp` command available system-wide:
152149

153150
```bash
154151
npm install -g .
155152
```
156153

157-
After global installation, you can use the `depscore` command from anywhere:
154+
After global installation, you can use the `socket-mcp` command from anywhere:
158155

159156
```bash
160157
export SOCKET_API_KEY=your_api_key_here
161-
depscore
158+
socket-mcp
162159
```

package-lock.json

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"type": "module",
55
"main": "./build/index.js",
66
"bin": {
7-
"depscore": "./build/index.js"
7+
"socket-mcp": "./build/index.js"
88
},
99
"scripts": {
1010
"build": "tsc && chmod 755 ./build/index.js",

0 commit comments

Comments
 (0)