Skip to content

docs: fix README/launch-post to match actual CLI flag and score semantics #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dmchaledev wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: fix README/launch-post to match actual CLI flag and score semantics #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ npx @hailbytes/mcp-security-scanner ./mcp-config.json
npx @hailbytes/mcp-security-scanner https://my-mcp-server.example.com

# Output SARIF for GitHub Code Scanning + fail on findings
npx @hailbytes/mcp-security-scanner ./config.json --output=sarif --exit-code
npx @hailbytes/mcp-security-scanner ./config.json --format=sarif --exit-code
```

### Programmatic
Expand All @@ -49,7 +49,7 @@ import { scan } from "@hailbytes/mcp-security-scanner";
const report = await scan({ configPath: "./mcp-config.json" });

console.log(report.findings); // Finding[] — individual security issues
console.log(report.score); // 0–100 risk score (lower = riskier)
console.log(report.score); // 0–100 risk score (higher = riskier; 0 is safest)
console.log(report.passed); // boolean — use as CI gate
```

Expand Down
2 changes: 1 addition & 1 deletion dev-to/launch-post.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ npx @hailbytes/mcp-security-scanner ./mcp-config.json
npx @hailbytes/mcp-security-scanner https://my-mcp-server.example.com

# SARIF output + fail the build
npx @hailbytes/mcp-security-scanner ./config.json --output=sarif --exit-code
npx @hailbytes/mcp-security-scanner ./config.json --format=sarif --exit-code
```

## Programmatic
Expand Down
Loading