Skip to main content
Glama
Sign In
MCP ZAP Server

MCP ZAP Server

by dtkmn
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Hybrid

zap_crawl_start

Start a guided crawl for a target host or root URL. The server decides direct versus queued execution from deployment topology.

Instructions

Start a guided crawl for a target host or root URL. The server decides direct versus queued execution from deployment topology. Use strategy=http for traditional server-rendered sites, strategy=client for JavaScript-driven apps using Client Spider, or strategy=browser for the existing AJAX Spider API. strategy=auto starts with HTTP Spider; only an unauthenticated direct HTTP start failure triggers AJAX fallback. Auto does not detect JavaScript coverage. Client Spider requires the Client Side Integration add-on and headless Firefox. Prepared browser authentication sessions require strategy=client; prepared HTTP form-login sessions require http or auto.

Input Schema

NameRequiredDescriptionDefault
strategyNoOptional crawl strategy: auto starts HTTP (unauthenticated direct mode alone falls back to AJAX on HTTP start failure), http for traditional link discovery, client for Client Spider on JavaScript-driven apps, or browser for the AJAX Spider API. Auto does not detect JavaScript coverage.
targetUrlYesTarget host or root URL to crawl, for example https://app.example.com or https://app.example.com/admin
authSessionIdNoOptional session ID from zap_auth_session_prepare. Use a kind=browser profile with strategy=client, or a kind=form profile with http/auto. The browser strategy means AJAX Spider and rejects authSessionId.
idempotencyKeyNoOptional idempotency key used only when guided execution selects queued mode; ignored in direct mode.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.16.0
    • changedInput schema / properties / strategy / description
      Previous value: -"Optional crawl strategy: auto for the default engine, http for traditional link discovery, client for Client Spider on JavaScript-driven apps, or browser for AJAX Spider."New value: +"Optional crawl strategy: auto starts HTTP (unauthenticated direct mode alone falls back to AJAX on HTTP start failure), http for traditional link discovery, client for Client Spider on JavaScript-driven apps, or browser for the AJAX Spider API. Auto does not detect JavaScript coverage."
  2. Changed2 schema fields changedv0.14.0
    • changedInput schema / properties / authSessionId / description
      Previous value: -"Optional prepared auth session ID from zap_auth_session_prepare. Guided crawl currently accepts form-login sessions only and rejects browser strategy when auth is supplied."New value: +"Optional session ID from zap_auth_session_prepare. Use a kind=browser profile with strategy=client, or a kind=form profile with http/auto. The browser strategy means AJAX Spider and rejects authSessionId."
    • changedInput schema / properties / strategy / description
      Previous value: -"Optional crawl strategy. Use auto to prefer the default guided engine, http for traditional pages and simple link discovery, or browser for SPAs, authenticated flows, and JavaScript-heavy navigation."New value: +"Optional crawl strategy: auto for the default engine, http for traditional link discovery, client for Client Spider on JavaScript-driven apps, or browser for AJAX Spider."
  3. First observed

TDQS

A4.7/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries the full burden and does so well: it discloses that the server decides direct vs queued execution, the narrow AJAX fallback condition, the Client Side Integration add-on and headless Firefox dependencies, and that auto does not detect JavaScript coverage. This is unusually rich behavioral context for a start operation.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loads purpose then strategy guidance, and every sentence is informative. However, it is a dense run-on paragraph and some statements (e.g., 'Auto does not detect JavaScript coverage') are repeated verbatim in the schema, slightly reducing efficiency.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Covers strategies, auth pairings, and the idempotency caveat, which is comprehensive for a crawl-start tool. It stops short of telling the agent what the call returns or how to track progress (e.g., via zap_crawl_status), which with no output schema would have been the natural closing detail.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% and the schema already documents all four parameters in detail, so the baseline is 3. The description adds interpretable value by explaining the strategy trade-offs and the authSessionId compatibility rules, edging above baseline, though much of it is echoed in the schema descriptions.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Start a guided crawl for a target host or root URL'), making it clearly distinct from siblings like zap_attack_start, zap_crawl_stop, and zap_crawl_status. An agent can identify the operation without opening the schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly maps each strategy value to a situation ('strategy=http for traditional server-rendered sites, strategy=client for JavaScript-driven apps...') and states the precise fallback trigger. It also spells out the auth-session pairing rule ('prepared browser authentication sessions require strategy=client').

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools