> For the complete documentation index, see [llms.txt](https://burp-ai-agent.six2dez.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://burp-ai-agent.six2dez.com/mcp-server/tools-reference.md).

# Tools Reference

Canonical reference for every MCP tool exposed by the extension. There are **59 MCP tools** in total. Each category has a summary table (safety, default exposure, Pro-only flag, one-line description) followed by per-tool input schemas.

```mermaid
mindmap
  root((MCP Tools))
    AI (extension-native)
    Burp Control
    Collaborator
    Config
    Editor
    Issues
    Extension
    History
    Requests
    Scanner
    Scope
    Site Map
    Utilities
```

## Extension-Native vs Generic Tools

The tools split into two groups, which the build you load decides between:

* **Extension-native (AI) tools — 8 total**: `status`, `issue_create`, `ai_analyze`, `ai_passive_scan`, `ai_findings_recent`, `redact_preview`, `ai_audit_query`, `ai_backends_list`. These are present in **both** the BApp Store build and the full build. They are marked **Native = Yes** in the tables below.
* **Generic (Montoya) tools — 51 total**: every other tool on this page (proxy history, repeater, scanner, scope, site map, intruder, Collaborator, utilities, etc.). These are present **only in the full build** (GitHub releases). The BApp Store build does not expose them — for those, run PortSwigger's official Burp MCP Server alongside this extension. They are marked **Native = No**.

The redesigned **MCP Tools** settings tab mirrors this split: tools are grouped into extension-native (AI) vs generic (Montoya), each tagged **store-build** or **full-build**, with search/filter and per-group bulk toggles.

Conventions:

* **Native = Yes** means the tool is extension-native and registered in both the BApp Store and full builds. **Native = No** means it is a generic Montoya tool, registered only in the full build.
* **Unsafe = Yes** means the tool can mutate Burp state or send traffic to targets. Tools marked unsafe are gated behind the **Enable Unsafe Tools** master switch in **Settings → MCP Server**.
* **Default enabled = Yes** means the tool is available in agent profiles without an explicit opt-in.
* **Pro only = Yes** means the tool requires Burp Suite Professional. Its handler is not registered for Community edition.
* **Input fields: none** means the tool takes no parameters.
* **Required** follows runtime decoding behavior. The reflection-based MCP schema currently advertises every non-null Kotlin property as required, including properties that have runtime defaults; strict schema-driven clients may therefore send more fields than the tables require. Kotlin deserialization accepts the documented omissions. Separately, the three scope models give `url` an empty-string default but reject blank input at construction time, so clients must supply it as shown below.

### Model-Emitted Confirmation Tiers

The confirmation tier is independent of **Unsafe** and **Default enabled**. It applies when the extension's own AI emits a tool call in chat; direct calls from an external MCP client remain governed by server authentication, tool enablement, edition, unsafe, and scope gates.

| Tier           | Count | Current catalog entries                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| -------------- | ----: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `AUTO`         |    19 | `ai_backends_list`, `base64_decode`, `base64_encode`, `decode_as`, `diff_requests`, `find_reflected`, `hash_compute`, `insertion_points`, `jwt_decode`, `params_extract`, `random_string`, `redact_preview`, `request_parse`, `response_parse`, `scan_task_status`, `scope_check`, `status`, `url_decode`, `url_encode`                                                                                                                                                                       |
| `CONFIRM`      |    24 | `ai_audit_query`, `ai_findings_recent`, `collaborator_generate`, `collaborator_poll`, `comparer_send`, `cookie_jar_get`, `editor_get`, `editor_set`, `issue_create`, `project_options_get`, `proxy_history_annotate`, `proxy_http_history`, `proxy_http_history_regex`, `proxy_intercept`, `proxy_ws_history`, `proxy_ws_history_regex`, `response_body_search`, `scan_task_delete`, `scanner_issues`, `scope_exclude`, `site_map`, `site_map_regex`, `task_engine_state`, `user_options_get` |
| `CONFIRM_EACH` |    16 | `ai_analyze`, `ai_passive_scan`, `http1_request`, `http2_request`, `intruder`, `intruder_prepare`, `project_options_set`, `repeater_tab`, `repeater_tab_with_payload`, `scan_audit_start`, `scan_audit_start_mode`, `scan_audit_start_requests`, `scan_crawl_start`, `scan_report`, `scope_include`, `user_options_set`                                                                                                                                                                       |

Unknown names and every `ext:` external-server tool fail closed to `CONFIRM_EACH`. See [MCP Security Model → Tool-Call Confirmation](/mcp-server/security-model.md#7-tool-call-confirmation-sec-06).

### Privacy Behavior of Tool Results

All normal tool results pass through `McpToolContext.redactIfNeeded` under the current privacy mode. Tools that preserve type information also sanitize before serialization: parsed headers use `sanitizeHeaders`, parsed parameters use `sanitizeParameters`, and cookie-jar values are suppressed unless mode is `OFF`.

The generic pass cannot infer every structured carrier. Current boundaries include real hosts in some raw history/site-map/scanner fields and non-cookie URL/body parameter values stored under a generic JSON `value` key. A scanner issue created under an earlier mode is not rewritten when read later. See [Redaction Coverage and Known Boundaries](/privacy-and-logging/limitations.md#redaction-coverage-and-known-boundaries) before feeding bulk results to a hosted model.

## AI (extension-native)

These tools call or support the extension's AI engine and are present in every build. There is a current gate mismatch to know about: `ai_analyze` and `ai_passive_scan` call Burp's `api.ai().isEnabled()` unconditionally before using the extension supervisor. They therefore refuse on Community or when **Use AI for extensions** is off, even if the selected backend is Ollama, Anthropic, or another independent backend. Chat and the normal scanner pipelines do not have that extra gate.

| Tool                 | Native | Unsafe | Default enabled | Pro only | Description                                                                                         |
| -------------------- | ------ | ------ | --------------- | -------- | --------------------------------------------------------------------------------------------------- |
| `ai_analyze`         | Yes    | No     | Yes             | No       | Sends text to the active AI backend and returns the analysis result.                                |
| `ai_passive_scan`    | Yes    | No     | Yes             | No       | Queues requests for AI passive security analysis and returns the count enqueued.                    |
| `ai_findings_recent` | Yes    | No     | Yes             | No       | Returns the most recent AI passive scan findings (up to `n`).                                       |
| `redact_preview`     | Yes    | No     | Yes             | No       | Applies the extension's privacy redaction engine to arbitrary text and returns the redacted result. |
| `ai_audit_query`     | Yes    | No     | Yes             | No       | Returns recent AI request audit log entries (hashes only unless verbose mode is enabled).           |
| `ai_backends_list`   | Yes    | No     | Yes             | No       | Lists available AI backends and reports the current active backend and connection state.            |

`status` and `issue_create` are also extension-native; see the **Extension** and **Issues** categories below.

### ai\_analyze

| Name              | Type    | Required | Default |
| ----------------- | ------- | -------- | ------- |
| `text`            | String  | Yes      | —       |
| `jsonMode`        | Boolean | No       | `false` |
| `maxOutputTokens` | Int?    | No       | `null`  |

### ai\_passive\_scan

| Name                  | Type       | Required | Default       |
| --------------------- | ---------- | -------- | ------------- |
| `proxyHistoryIndices` | List\<Int> | No       | `emptyList()` |
| `siteMapUrl`          | String?    | No       | `null`        |
| `maxRequests`         | Int        | No       | `10`          |

### ai\_findings\_recent

| Name | Type | Required | Default |
| ---- | ---- | -------- | ------- |
| `n`  | Int  | No       | `10`    |

### redact\_preview

| Name   | Type   | Required | Default    |
| ------ | ------ | -------- | ---------- |
| `text` | String | Yes      | —          |
| `mode` | String | No       | `"STRICT"` |

### ai\_audit\_query

| Name | Type | Required | Default |
| ---- | ---- | -------- | ------- |
| `n`  | Int  | No       | `20`    |

### ai\_backends\_list

Input fields: none.

## Burp Control

| Tool                | Native | Unsafe | Default enabled | Pro only | Description                                             |
| ------------------- | ------ | ------ | --------------- | -------- | ------------------------------------------------------- |
| `proxy_intercept`   | No     | Yes    | No              | No       | Enables or disables Proxy intercept.                    |
| `task_engine_state` | No     | Yes    | No              | No       | Sets Burp's task execution engine to paused or running. |

### proxy\_intercept

| Name           | Type    | Required | Default |
| -------------- | ------- | -------- | ------- |
| `intercepting` | Boolean | Yes      | —       |

### task\_engine\_state

| Name      | Type    | Required | Default |
| --------- | ------- | -------- | ------- |
| `running` | Boolean | Yes      | —       |

## Collaborator

| Tool                    | Native | Unsafe | Default enabled | Pro only | Description                                         |
| ----------------------- | ------ | ------ | --------------- | -------- | --------------------------------------------------- |
| `collaborator_generate` | No     | No     | Yes             | No       | Generates a Burp Collaborator payload.              |
| `collaborator_poll`     | No     | No     | Yes             | No       | Fetches interactions for a Collaborator secret key. |

### collaborator\_generate

| Name         | Type          | Required | Default       |
| ------------ | ------------- | -------- | ------------- |
| `customData` | String?       | No       | `null`        |
| `options`    | List\<String> | No       | `emptyList()` |

### collaborator\_poll

| Name          | Type    | Required | Default |
| ------------- | ------- | -------- | ------- |
| `secretKey`   | String  | Yes      | —       |
| `includeHttp` | Boolean | No       | `false` |

## Config

| Tool                  | Native | Unsafe | Default enabled | Pro only | Description                                  |
| --------------------- | ------ | ------ | --------------- | -------- | -------------------------------------------- |
| `project_options_get` | No     | No     | No              | No       | Outputs project-level configuration as JSON. |
| `project_options_set` | No     | Yes    | No              | No       | Sets project-level configuration from JSON.  |
| `user_options_get`    | No     | No     | No              | No       | Outputs user-level configuration as JSON.    |
| `user_options_set`    | No     | Yes    | No              | No       | Sets user-level configuration from JSON.     |

### project\_options\_get

Input fields: none.

### project\_options\_set

| Name   | Type   | Required | Default |
| ------ | ------ | -------- | ------- |
| `json` | String | Yes      | —       |

### user\_options\_get

Input fields: none.

### user\_options\_set

| Name   | Type   | Required | Default |
| ------ | ------ | -------- | ------- |
| `json` | String | Yes      | —       |

## Editor

| Tool         | Native | Unsafe | Default enabled | Pro only | Description                                        |
| ------------ | ------ | ------ | --------------- | -------- | -------------------------------------------------- |
| `editor_get` | No     | No     | No              | No       | Outputs the contents of the active message editor. |
| `editor_set` | No     | Yes    | No              | No       | Sets the content of the active message editor.     |

### editor\_get

Input fields: none.

### editor\_set

| Name   | Type   | Required | Default |
| ------ | ------ | -------- | ------- |
| `text` | String | Yes      | —       |

## Issues

| Tool           | Native | Unsafe | Default enabled | Pro only | Description                                        |
| -------------- | ------ | ------ | --------------- | -------- | -------------------------------------------------- |
| `issue_create` | Yes    | No     | Yes             | No       | Creates a custom audit issue in Burp's issue list. |

### issue\_create

| Name                    | Type    | Required | Default |
| ----------------------- | ------- | -------- | ------- |
| `name`                  | String  | Yes      | —       |
| `detail`                | String  | Yes      | —       |
| `baseUrl`               | String  | Yes      | —       |
| `severity`              | String  | Yes      | —       |
| `confidence`            | String  | Yes      | —       |
| `remediation`           | String? | No       | `null`  |
| `background`            | String? | No       | `null`  |
| `remediationBackground` | String? | No       | `null`  |
| `typicalSeverity`       | String? | No       | `null`  |
| `httpRequest`           | String? | No       | `null`  |
| `httpResponseContent`   | String? | No       | `null`  |
| `targetHostname`        | String  | No       | `""`    |
| `targetPort`            | Int     | No       | `443`   |
| `usesHttps`             | Boolean | No       | `true`  |

When `httpRequest` is supplied, `targetHostname` must be non-blank and `targetPort` positive despite their model defaults. `httpResponseContent` is used only with `httpRequest`; otherwise the handler looks for a Proxy history match by `baseUrl`.

See [Issue Creation (MCP)](/mcp-server/issue-create.md) for guidance on building well-formed issue payloads.

## Extension

| Tool     | Native | Unsafe | Default enabled | Pro only | Description                              |
| -------- | ------ | ------ | --------------- | -------- | ---------------------------------------- |
| `status` | Yes    | No     | Yes             | No       | Returns basic extension and Burp status. |

### status

Input fields: none.

## History

| Tool                       | Native | Unsafe | Default enabled | Pro only | Description                                                    |
| -------------------------- | ------ | ------ | --------------- | -------- | -------------------------------------------------------------- |
| `proxy_history_annotate`   | No     | Yes    | No              | No       | Adds notes/highlights to proxy history items matching a regex. |
| `proxy_http_history`       | No     | No     | Yes             | No       | Displays items within the proxy HTTP history.                  |
| `proxy_http_history_regex` | No     | No     | Yes             | No       | Displays proxy HTTP history items matching a regex.            |
| `proxy_ws_history`         | No     | No     | Yes             | No       | Displays items within the proxy WebSocket history.             |
| `proxy_ws_history_regex`   | No     | No     | Yes             | No       | Displays WebSocket history items matching a regex.             |
| `response_body_search`     | No     | No     | Yes             | No       | Searches response bodies in proxy history using a regex.       |

`proxy_http_history`, `proxy_http_history_regex`, and `response_body_search` use the MCP proxy-history preprocessing controls (see **Settings → MCP Server → MCP Proxy History Preprocessing**). WebSocket history has its own direct serialization path.

### proxy\_history\_annotate

| Name        | Type    | Required | Default |
| ----------- | ------- | -------- | ------- |
| `regex`     | String  | Yes      | —       |
| `note`      | String  | Yes      | —       |
| `highlight` | String? | No       | `null`  |
| `scopeOnly` | Boolean | No       | `true`  |
| `limit`     | Int     | No       | `20`    |

### proxy\_http\_history

| Name                            | Type    | Required | Default |
| ------------------------------- | ------- | -------- | ------- |
| `count`                         | Int     | No       | `5`     |
| `offset`                        | Int     | No       | `0`     |
| `listenerPort`                  | Int?    | No       | `null`  |
| `includeUnpreprocessedResponse` | Boolean | No       | `false` |

`includeUnpreprocessedResponse` is advertised only when **Allow unpreprocessed proxy history** is enabled. The `listenerPort` filter remains available in either schema shape.

### proxy\_http\_history\_regex

| Name                            | Type    | Required | Default |
| ------------------------------- | ------- | -------- | ------- |
| `regex`                         | String  | Yes      | —       |
| `count`                         | Int     | No       | `5`     |
| `offset`                        | Int     | No       | `0`     |
| `includeUnpreprocessedResponse` | Boolean | No       | `false` |

`includeUnpreprocessedResponse` is omitted from the advertised schema when raw history is disabled.

### proxy\_ws\_history

| Name     | Type | Required | Default |
| -------- | ---- | -------- | ------- |
| `count`  | Int  | No       | `5`     |
| `offset` | Int  | No       | `0`     |

### proxy\_ws\_history\_regex

| Name     | Type   | Required | Default |
| -------- | ------ | -------- | ------- |
| `regex`  | String | Yes      | —       |
| `count`  | Int    | No       | `5`     |
| `offset` | Int    | No       | `0`     |

### response\_body\_search

| Name        | Type    | Required | Default |
| ----------- | ------- | -------- | ------- |
| `regex`     | String  | Yes      | —       |
| `count`     | Int     | No       | `5`     |
| `offset`    | Int     | No       | `0`     |
| `scopeOnly` | Boolean | No       | `true`  |

## Requests

| Tool                        | Native | Unsafe | Default enabled | Pro only | Description                                                                                                                                           |
| --------------------------- | ------ | ------ | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `comparer_send`             | No     | Yes    | No              | No       | Sends one or more items to Burp Comparer.                                                                                                             |
| `diff_requests`             | No     | No     | Yes             | No       | Produces a line diff between two requests.                                                                                                            |
| `find_reflected`            | No     | No     | Yes             | No       | Finds reflected parameter values in a response.                                                                                                       |
| `http1_request`             | No     | Yes    | Yes             | No       | Issues an HTTP/1.1 request and returns the response. Enabled in the catalog by default, but still blocked until the Unsafe Tools master switch is on. |
| `http2_request`             | No     | Yes    | Yes             | No       | Issues an HTTP/2 request and returns the response. Enabled in the catalog by default, but still blocked until the Unsafe Tools master switch is on.   |
| `insertion_points`          | No     | No     | Yes             | No       | Lists insertion point offsets for a request.                                                                                                          |
| `intruder`                  | No     | Yes    | No              | No       | Sends a request to Intruder.                                                                                                                          |
| `intruder_prepare`          | No     | Yes    | No              | No       | Creates an Intruder tab with explicit insertion points.                                                                                               |
| `params_extract`            | No     | No     | Yes             | No       | Extracts parameters from a request.                                                                                                                   |
| `repeater_tab`              | No     | Yes    | No              | No       | Creates a new Repeater tab with the specified HTTP request.                                                                                           |
| `repeater_tab_with_payload` | No     | Yes    | No              | No       | Creates a Repeater tab after applying placeholder replacements.                                                                                       |
| `request_parse`             | No     | No     | Yes             | No       | Parses a raw HTTP request into method, path, headers, parameters, and body.                                                                           |
| `response_parse`            | No     | No     | Yes             | No       | Parses a raw HTTP response into status, headers, and body.                                                                                            |

{% hint style="info" %}
`http1_request` and `http2_request` require **Enable Unsafe Tools** in the MCP Server tab. The built-in agent profiles (pentester, bughunter, auditor) list these tools as optional — no validation warning is shown when they are disabled. Custom profiles that explicitly reference these tools will warn until Unsafe Tools are enabled.
{% endhint %}

### comparer\_send

| Name    | Type          | Required | Default |
| ------- | ------------- | -------- | ------- |
| `items` | List\<String> | Yes      | —       |

### diff\_requests

| Name       | Type   | Required | Default |
| ---------- | ------ | -------- | ------- |
| `requestA` | String | Yes      | —       |
| `requestB` | String | Yes      | —       |

### find\_reflected

| Name       | Type   | Required | Default |
| ---------- | ------ | -------- | ------- |
| `request`  | String | Yes      | —       |
| `response` | String | Yes      | —       |

### http1\_request

| Name             | Type    | Required | Default |
| ---------------- | ------- | -------- | ------- |
| `content`        | String  | Yes      | —       |
| `targetHostname` | String  | Yes      | —       |
| `targetPort`     | Int     | Yes      | —       |
| `usesHttps`      | Boolean | Yes      | —       |

### http2\_request

| Name             | Type                 | Required | Default |
| ---------------- | -------------------- | -------- | ------- |
| `pseudoHeaders`  | Map\<String, String> | Yes      | —       |
| `headers`        | Map\<String, String> | Yes      | —       |
| `requestBody`    | String               | Yes      | —       |
| `targetHostname` | String               | Yes      | —       |
| `targetPort`     | Int                  | Yes      | —       |
| `usesHttps`      | Boolean              | Yes      | —       |

### insertion\_points

| Name      | Type   | Required | Default                                       |
| --------- | ------ | -------- | --------------------------------------------- |
| `content` | String | Yes      | —                                             |
| `mode`    | String | No       | `"REPLACE_BASE_PARAMETER_VALUE_WITH_OFFSETS"` |

### intruder

| Name             | Type    | Required | Default |
| ---------------- | ------- | -------- | ------- |
| `tabName`        | String? | Yes      | —       |
| `content`        | String  | Yes      | —       |
| `targetHostname` | String  | Yes      | —       |
| `targetPort`     | Int     | Yes      | —       |
| `usesHttps`      | Boolean | Yes      | —       |

### intruder\_prepare

| Name              | Type                       | Required | Default                                       |
| ----------------- | -------------------------- | -------- | --------------------------------------------- |
| `tabName`         | String?                    | Yes      | —                                             |
| `content`         | String                     | Yes      | —                                             |
| `insertionPoints` | List\<InsertionPointRange> | No       | `emptyList()`                                 |
| `mode`            | String                     | No       | `"REPLACE_BASE_PARAMETER_VALUE_WITH_OFFSETS"` |
| `targetHostname`  | String                     | Yes      | —                                             |
| `targetPort`      | Int                        | Yes      | —                                             |
| `usesHttps`       | Boolean                    | Yes      | —                                             |

### params\_extract

| Name      | Type   | Required | Default |
| --------- | ------ | -------- | ------- |
| `content` | String | Yes      | —       |

Cookie-typed parameters are returned with `[STRIPPED]` in `STRICT` and `BALANCED`. Other parameter types preserve their value; a sensitive-looking parameter name alone does not make this structured result type `COOKIE`.

### repeater\_tab

| Name             | Type    | Required | Default |
| ---------------- | ------- | -------- | ------- |
| `tabName`        | String? | Yes      | —       |
| `content`        | String  | Yes      | —       |
| `targetHostname` | String  | Yes      | —       |
| `targetPort`     | Int     | Yes      | —       |
| `usesHttps`      | Boolean | Yes      | —       |

### repeater\_tab\_with\_payload

| Name             | Type                 | Required | Default |
| ---------------- | -------------------- | -------- | ------- |
| `tabName`        | String?              | Yes      | —       |
| `content`        | String               | Yes      | —       |
| `replacements`   | Map\<String, String> | Yes      | —       |
| `targetHostname` | String               | Yes      | —       |
| `targetPort`     | Int                  | Yes      | —       |
| `usesHttps`      | Boolean              | Yes      | —       |

### request\_parse

| Name          | Type    | Required | Default |
| ------------- | ------- | -------- | ------- |
| `content`     | String  | Yes      | —       |
| `includeBody` | Boolean | No       | `false` |

Recognized cookie headers and cookie-typed parameters are sanitized before JSON serialization. URL/body parameter values can remain visible under the generic `value` field; inspect the result or pre-sanitize caller-supplied content when that distinction matters.

### response\_parse

| Name          | Type    | Required | Default |
| ------------- | ------- | -------- | ------- |
| `content`     | String  | Yes      | —       |
| `includeBody` | Boolean | No       | `false` |

Recognized cookie and credential headers are sanitized before JSON serialization. The final serialized result also passes through the current read-time text policy.

## Scanner

| Tool                        | Native | Unsafe | Default enabled | Pro only | Description                                          |
| --------------------------- | ------ | ------ | --------------- | -------- | ---------------------------------------------------- |
| `scan_audit_start`          | No     | Yes    | No              | Yes      | Starts a Burp Scanner audit.                         |
| `scan_audit_start_mode`     | No     | Yes    | No              | Yes      | Starts a scanner audit using active or passive mode. |
| `scan_audit_start_requests` | No     | Yes    | No              | Yes      | Starts an audit and adds HTTP requests.              |
| `scan_crawl_start`          | No     | Yes    | No              | Yes      | Starts a Burp Scanner crawl.                         |
| `scan_report`               | No     | Yes    | No              | Yes      | Generates a scanner report to a path.                |
| `scan_task_delete`          | No     | Yes    | No              | Yes      | Deletes a crawl/audit task started via MCP.          |
| `scan_task_status`          | No     | No     | No              | Yes      | Gets status for a crawl/audit task.                  |
| `scanner_issues`            | No     | No     | Yes             | Yes      | Displays scanner issues (Burp Pro only).             |

### scan\_audit\_start

| Name                   | Type   | Required | Default |
| ---------------------- | ------ | -------- | ------- |
| `builtInConfiguration` | String | Yes      | —       |

### scan\_audit\_start\_mode

| Name             | Type          | Required | Default       |
| ---------------- | ------------- | -------- | ------------- |
| `mode`           | String        | Yes      | —             |
| `requests`       | List\<String> | No       | `emptyList()` |
| `targetHostname` | String        | No       | `""`          |
| `targetPort`     | Int           | No       | `0`           |
| `usesHttps`      | Boolean       | No       | `true`        |

### scan\_audit\_start\_requests

| Name                   | Type          | Required | Default |
| ---------------------- | ------------- | -------- | ------- |
| `builtInConfiguration` | String        | Yes      | —       |
| `requests`             | List\<String> | Yes      | —       |
| `targetHostname`       | String        | Yes      | —       |
| `targetPort`           | Int           | Yes      | —       |
| `usesHttps`            | Boolean       | Yes      | —       |

### scan\_crawl\_start

| Name       | Type          | Required | Default |
| ---------- | ------------- | -------- | ------- |
| `seedUrls` | List\<String> | Yes      | —       |

### scan\_report

| Name        | Type    | Required | Default |
| ----------- | ------- | -------- | ------- |
| `taskId`    | String? | Yes      | —       |
| `allIssues` | Boolean | Yes      | —       |
| `format`    | String  | Yes      | —       |
| `path`      | String  | Yes      | —       |

### scan\_task\_delete

| Name     | Type   | Required | Default |
| -------- | ------ | -------- | ------- |
| `taskId` | String | Yes      | —       |

### scan\_task\_status

| Name     | Type   | Required | Default |
| -------- | ------ | -------- | ------- |
| `taskId` | String | Yes      | —       |

### scanner\_issues

| Name     | Type | Required | Default |
| -------- | ---- | -------- | ------- |
| `count`  | Int  | No       | `5`     |
| `offset` | Int  | No       | `0`     |

## Scope

| Tool            | Native | Unsafe | Default enabled | Pro only | Description                       |
| --------------- | ------ | ------ | --------------- | -------- | --------------------------------- |
| `scope_check`   | No     | No     | Yes             | No       | Checks whether a URL is in scope. |
| `scope_exclude` | No     | Yes    | No              | No       | Excludes a URL from scope.        |
| `scope_include` | No     | Yes    | No              | No       | Includes a URL in scope.          |

### scope\_check

| Name  | Type   | Required | Default |
| ----- | ------ | -------- | ------- |
| `url` | String | Yes      | —       |

### scope\_exclude

| Name  | Type   | Required | Default |
| ----- | ------ | -------- | ------- |
| `url` | String | Yes      | —       |

### scope\_include

| Name  | Type   | Required | Default |
| ----- | ------ | -------- | ------- |
| `url` | String | Yes      | —       |

## Site Map

| Tool             | Native | Unsafe | Default enabled | Pro only | Description                               |
| ---------------- | ------ | ------ | --------------- | -------- | ----------------------------------------- |
| `site_map`       | No     | No     | Yes             | No       | Displays items within the Burp site map.  |
| `site_map_regex` | No     | No     | Yes             | No       | Displays site map items matching a regex. |

### site\_map

| Name     | Type | Required | Default |
| -------- | ---- | -------- | ------- |
| `count`  | Int  | No       | `5`     |
| `offset` | Int  | No       | `0`     |

### site\_map\_regex

| Name     | Type   | Required | Default |
| -------- | ------ | -------- | ------- |
| `regex`  | String | Yes      | —       |
| `count`  | Int    | No       | `5`     |
| `offset` | Int    | No       | `0`     |

## Utilities

| Tool             | Native | Unsafe | Default enabled | Pro only | Description                                                                     |
| ---------------- | ------ | ------ | --------------- | -------- | ------------------------------------------------------------------------------- |
| `base64_decode`  | No     | No     | Yes             | No       | Base64 decodes the input string.                                                |
| `base64_encode`  | No     | No     | Yes             | No       | Base64 encodes the input string.                                                |
| `cookie_jar_get` | No     | No     | Yes             | No       | Returns cookies from Burp's cookie jar (values redacted unless privacy is OFF). |
| `decode_as`      | No     | No     | Yes             | No       | Decodes base64 content using compression codecs (gzip/deflate/brotli).          |
| `hash_compute`   | No     | No     | Yes             | No       | Computes a hash for input text (MD5/SHA1/SHA256/SHA512).                        |
| `jwt_decode`     | No     | No     | Yes             | No       | Decodes JWT header/payload without verifying the signature.                     |
| `random_string`  | No     | No     | Yes             | No       | Generates a random string of specified length and character set.                |
| `url_decode`     | No     | No     | Yes             | No       | URL decodes the input string.                                                   |
| `url_encode`     | No     | No     | Yes             | No       | URL encodes the input string.                                                   |

### base64\_decode

| Name      | Type   | Required | Default |
| --------- | ------ | -------- | ------- |
| `content` | String | Yes      | —       |

### base64\_encode

| Name      | Type   | Required | Default |
| --------- | ------ | -------- | ------- |
| `content` | String | Yes      | —       |

### cookie\_jar\_get

| Name                | Type    | Required | Default |
| ------------------- | ------- | -------- | ------- |
| `domain`            | String? | No       | `null`  |
| `includeSubdomains` | Boolean | No       | `true`  |
| `scopeOnly`         | Boolean | No       | `true`  |
| `includeValues`     | Boolean | No       | `false` |

### decode\_as

| Name       | Type   | Required | Default |
| ---------- | ------ | -------- | ------- |
| `base64`   | String | Yes      | —       |
| `encoding` | String | Yes      | —       |

### hash\_compute

| Name        | Type   | Required | Default |
| ----------- | ------ | -------- | ------- |
| `content`   | String | Yes      | —       |
| `algorithm` | String | Yes      | —       |

### jwt\_decode

| Name    | Type   | Required | Default |
| ------- | ------ | -------- | ------- |
| `token` | String | Yes      | —       |

### random\_string

| Name           | Type   | Required | Default |
| -------------- | ------ | -------- | ------- |
| `length`       | Int    | Yes      | —       |
| `characterSet` | String | Yes      | —       |

### url\_decode

| Name      | Type   | Required | Default |
| --------- | ------ | -------- | ------- |
| `content` | String | Yes      | —       |

### url\_encode

| Name      | Type   | Required | Default |
| --------- | ------ | -------- | ------- |
| `content` | String | Yes      | —       |

## Related Pages

* [MCP Overview](/mcp-server/overview.md)
* [Security Model](/mcp-server/security-model.md)
* [Issue Creation (MCP)](/mcp-server/issue-create.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://burp-ai-agent.six2dez.com/mcp-server/tools-reference.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.