dotnet-zap-mcp

MCP (Model Context Protocol) server for OWASP ZAP. Enables AI agents (Claude, GitHub Copilot, etc.) to drive ZAP vulnerability scanning via MCP.
Features
- 45 MCP tools for controlling OWASP ZAP (scanning, alerts, spider, ajax spider, context, authentication, reports, etc.)
- Built-in Docker Compose management (start/stop ZAP with a single tool call)
- Zero-config setup: auto-generates API keys and extracts Docker assets
- Works with any MCP-compatible client (Claude Desktop, VS Code, etc.)
Installation
dotnet tool install -g dotnet-zap-mcp
Prerequisites
- .NET 10 SDK
- Docker (Docker Engine or Docker Desktop) with
docker compose support (for built-in ZAP container management)
Configuration
Zero-config (recommended)
No configuration needed. The agent calls DockerComposeUp which automatically:
- Extracts Docker assets to
~/.zap-mcp/docker/
- Generates a random API key
- Starts the ZAP container on
localhost:8090
- Waits for ZAP to become healthy
Data persistence
The ZAP container uses two Docker named volumes:
| Volume | Container Path | Purpose |
|---|
zap-home | /home/zap/.ZAP | ZAP settings, contexts, sessions, scan policies (persisted across restarts) |
zap-data | /zap/wrk/data | Shared directory for reports, session files, and context import/export |
On the first launch, the template config.xml is copied into zap-home. On subsequent launches, only the API key is updated β any changes made through ZAP (contexts, authentication settings, scan policies, etc.) are preserved.
The zap-data volume contains:
reports/ β generated scan reports
sessions/ β saved ZAP sessions
contexts/ β exported context files
Claude Desktop / Claude Code
Add to your MCP configuration:
{
"mcpServers": {
"zap": {
"command": "zap-mcp"
}
}
}
VS Code (Copilot)
Add to .vscode/mcp.json:
{
"servers": {
"zap": {
"command": "zap-mcp"
}
}
}
With existing ZAP instance
If you already have a ZAP instance running, pass connection details via environment variables:
{
"mcpServers": {
"zap": {
"command": "zap-mcp",
"env": {
"ZAP_BASE_URL": "http://localhost:8090",
"ZAP_API_KEY": "your-api-key"
}
}
}
}
Available Tools
Docker Management
| Tool | Parameters | Description |
|---|
DockerComposeUp | β | Start the ZAP container and wait for healthy |
DockerComposeDown | β | Stop and remove the ZAP container |
DockerComposeStatus | β | Check container status |
DockerComposeLogs | tail | Get recent container logs |
ZAP Core
| Tool | Parameters | Description |
|---|
GetVersion | β | Verify ZAP connectivity |
GetHosts | β | List recorded hosts |
GetSites | β | List recorded sites |
GetUrls | baseUrl | List recorded URLs for a base URL |
Spider
| Tool | Parameters | Description |
|---|
StartSpider | url, maxChildren, recurse, subtreeOnly, contextName | Start a spider scan to crawl and discover pages |
GetSpiderStatus | scanId | Check spider progress (0-100%) |
GetSpiderResults | scanId | Get URLs discovered by spider |
StopSpider | scanId | Stop a running spider scan |
Active Scan
| Tool | Parameters | Description |
|---|
StartActiveScan | url, recurse, inScopeOnly, scanPolicyName, contextId | Start an active vulnerability scan |
GetActiveScanStatus | scanId | Check active scan progress (0-100%) |
StopActiveScan | scanId | Stop a running active scan |
Passive Scan
| Tool | Parameters | Description |
|---|
GetPassiveScanStatus | β | Check passive scan progress (records remaining) |
Alerts
| Tool | Parameters | Description |
|---|
GetAlertsSummary | baseUrl | Alert counts by risk level |
GetAlerts | baseUrl, start, count, riskId | Detailed alert list with pagination and risk filter |
Reports
| Tool | Parameters | Description |
|---|
GetHtmlReport | β | Generate HTML scan report |
GetJsonReport | β | Generate JSON scan report |
GetXmlReport | β | Generate XML scan report |
Context Management
| Tool | Parameters | Description |
|---|
GetContextList | β | List all contexts defined in ZAP |
GetContext | contextName | Get context details (scope patterns, etc.) |
CreateContext | contextName | Create a new context |
RemoveContext | contextName | Delete a context |
IncludeInContext | contextName, regex | Add URL include pattern to context scope |
ExcludeFromContext | contextName, regex | Add URL exclude pattern to context scope |
ImportContext | contextFilePath | Import a context file into ZAP |
ExportContext | contextName, contextFilePath | Export a context to file |
Authentication
| Tool | Parameters | Description |
|---|
GetAuthenticationMethod | contextId | Get the authentication method configured for a context |
SetAuthenticationMethod | contextId, authMethodName, authMethodConfigParams | Set authentication method (form-based, JSON-based, script-based, HTTP) |
SetLoggedInIndicator | contextId, loggedInIndicatorRegex | Set regex pattern indicating logged-in state |
SetLoggedOutIndicator | contextId, loggedOutIndicatorRegex | Set regex pattern indicating logged-out state |
Users
| Tool | Parameters | Description |
|---|
GetUsersList | contextId | List all users for a context |
CreateUser | contextId, name | Create a new user |
RemoveUser | contextId, userId | Remove a user |
SetAuthenticationCredentials | contextId, userId, authCredentialsConfigParams | Set user credentials (username/password) |
SetUserEnabled | contextId, userId, enabled | Enable or disable a user |
Forced User
| Tool | Parameters | Description |
|---|
SetForcedUser | contextId, userId | Set the forced user for a context |
SetForcedUserModeEnabled | enabled | Enable or disable forced user mode globally |
GetForcedUserStatus | contextId | Get forced user mode status and current forced user |
Ajax Spider
| Tool | Parameters | Description |
|---|
StartAjaxSpider | url, inScope, contextName, subtreeOnly | Start the Ajax Spider for JavaScript-heavy apps |
StartAjaxSpiderAsUser | contextName, userId, url, subtreeOnly | Start the Ajax Spider as a specific user |
GetAjaxSpiderStatus | β | Get Ajax Spider status (running/stopped) |
GetAjaxSpiderResults | β | Get Ajax Spider results summary |
StopAjaxSpider | β | Stop the Ajax Spider |
Typical Workflow
- Agent calls
DockerComposeUp to start ZAP
- Configure browser/Playwright to use ZAP as proxy (
http://127.0.0.1:8090)
- Browse the target application through the proxy
- Agent calls
StartSpider to crawl the application, then GetSpiderStatus to monitor progress
- Agent calls
GetPassiveScanStatus to wait for passive scan completion
- Agent calls
StartActiveScan on key pages, then GetActiveScanStatus to monitor progress
- Agent calls
GetAlertsSummary and GetAlerts to retrieve vulnerability findings
- Agent calls
GetHtmlReport or GetJsonReport to generate a scan report
- Agent calls
DockerComposeDown when done
Note: ZAP settings (contexts, authentication, scan policies) are persisted in the zap-home Docker volume. You can stop and restart the container without losing configuration.
Try It Out (with the included vulnerable app)
This repository includes an intentionally vulnerable web application for trying out ZAP scanning. The app contains common vulnerabilities (XSS, SQL Injection, CSRF, Open Redirect) so ZAP can detect real findings.
Setup
# Start ZAP and the vulnerable target app
docker compose -f tests/docker/docker-compose.test.yml up -d --build
# Wait until both containers are healthy
docker compose -f tests/docker/docker-compose.test.yml ps
Then configure your MCP client to connect to this ZAP instance:
{
"mcpServers": {
"zap": {
"command": "zap-mcp",
"env": {
"ZAP_BASE_URL": "http://localhost:8090",
"ZAP_API_KEY": "test-api-key-for-ci"
}
}
}
}
The vulnerable app is accessible at http://target from within the Docker network (used by ZAP), and at http://localhost:8080 from your host machine.
Example 1: Quick Scan
Prompt to agent:
Scan http://target for vulnerabilities. Run a spider crawl, wait for the passive scan to finish, then show me the alert summary and generate an HTML report.
Expected tool flow:
GetVersion β Verify ZAP connectivity
StartSpider β url: "http://target"
GetSpiderStatus β Poll until 100%
GetPassiveScanStatus β Poll until 0 records remaining
GetAlertsSummary β baseUrl: "http://target"
GetAlerts β baseUrl: "http://target"
GetHtmlReport β Generate report