Skip to content

Commit 962412a

Browse files
authored
feat(local): add the mcp watch local support
1 parent 9e0454a commit 962412a

File tree

5 files changed

+334
-85
lines changed

5 files changed

+334
-85
lines changed

README.md

Lines changed: 80 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,42 @@ A comprehensive security scanner for Model Context Protocol (MCP) servers that d
1717
- **🌊 Toxic Flows** - Identifies dangerous data flow patterns
1818
- **🔐 Permission Issues** - Finds excessive permissions and access control problems
1919

20+
## Quick Start 🚀
21+
22+
### Option 1: NPM Package (Recommended)
23+
```bash
24+
# Install globally
25+
npm install -g mcp-watch
26+
27+
# Scan any GitHub MCP repository
28+
mcp-watch scan https://github.com/user/mcp-server
29+
30+
# Scan your local MCP project
31+
mcp-watch scan-local /path/to/your/mcp-project
32+
```
33+
34+
### Option 2: From GitHub Source
35+
```bash
36+
# Clone and use immediately
37+
git clone https://github.com/kapilduraphe/mcp-watch.git
38+
cd mcp-watch
39+
npm install
40+
npm run build
41+
42+
# Scan GitHub repos
43+
npm run scan:github https://github.com/user/mcp-server
44+
45+
# Scan local projects
46+
npm run scan:local /path/to/your/mcp-project
47+
```
48+
49+
### Option 3: Docker (No Installation)
50+
```bash
51+
# Scan without installing anything
52+
docker run --rm mcp-watch scan https://github.com/user/mcp-server
53+
docker run --rm -v $(pwd):/workspace mcp-watch scan-local /workspace
54+
```
55+
2056
## Installation
2157

2258
### Global Installation
@@ -77,6 +113,7 @@ docker compose run --rm mcp-watch scan https://github.com/user/repo
77113

78114
### Command Line
79115

116+
#### Scan GitHub Repositories
80117
```bash
81118
# Scan a GitHub repository
82119
mcp-watch scan https://github.com/user/mcp-server
@@ -91,9 +128,50 @@ mcp-watch scan https://github.com/user/mcp-server --severity high
91128
mcp-watch scan https://github.com/user/mcp-server --category credential-leak
92129
```
93130

94-
**Note:** If you don't want to download npm then just substitute `mcp-watch` with `node dist/main.js`.
131+
#### Scan Local Projects
132+
```bash
133+
# Scan current directory
134+
mcp-watch scan-local .
135+
136+
# Scan specific directory (absolute path)
137+
mcp-watch scan-local /path/to/your/mcp-project
138+
139+
# Scan specific directory (relative path)
140+
mcp-watch scan-local ../my-mcp-server
141+
142+
# Local scan with JSON output
143+
mcp-watch scan-local . --format json
144+
145+
# Local scan with severity filter
146+
mcp-watch scan-local . --severity high
147+
```
148+
149+
### Installation Method Usage
150+
151+
#### From NPM Package
152+
```bash
153+
# Global installation (recommended)
154+
npm install -g mcp-watch
155+
mcp-watch scan https://github.com/user/mcp-server
156+
mcp-watch scan-local /path/to/project
157+
```
158+
159+
#### From GitHub Source
160+
```bash
161+
# Clone and build
162+
git clone https://github.com/kapilduraphe/mcp-watch.git
163+
cd mcp-watch
164+
npm install
165+
npm run build
95166

96-
**Example:** `node dist/main.js scan https://github.com/user/repo`
167+
# Use built version
168+
node dist/main.js scan https://github.com/user/mcp-server
169+
node dist/main.js scan-local /path/to/project
170+
171+
# Or use npm scripts
172+
npm run scan https://github.com/user/mcp-server
173+
npm run scan-local /path/to/project
174+
```
97175

98176
### Docker Usage 🐳
99177

package-lock.json

Lines changed: 81 additions & 80 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)