For the complete documentation index, see llms.txt. This page is also available as Markdown.

Settings Reference

This page documents configurable settings in the extension (which appears as Custom AI Agent in Burp's Extensions list and Suite tab), organized by settings tab.

As of v0.8.0 the Settings tabs were rebuilt on an internal design system: consistent layout, one-line section descriptions, and collapsible sections on the dense scanner tabs, all re-theming automatically when Burp switches light/dark. The settings keys and persistence are unchanged — saved configurations load exactly as before. The tables below list those keys.

For tuning model spend, also see Token Usage & Cost Management. Contributors extending the plugin with new settings should read Settings Migration for how the schema is versioned and how to add a forward-only migration step.

AI Backend

Setting
Type
Default
Description

Preferred Backend

Dropdown

burp-ai

Backend used for new chat sessions. All registered backends are shown regardless of CLI availability; errors are reported at usage time via health check. Defaults to the built-in Burp AI backend when Burp Pro exposes AI capability; otherwise pick another backend explicitly.

Burp AI (built-in)

Dropdown selection

(auto-detected)

In-process backend available only when Burp Pro is running with Use AI for extensions enabled. No URL, model, or credentials are required — configuration lives in Burp's own AI settings. See Burp AI (Built-in).

Codex CLI Command

Text

codex chat

Shell command used to launch Codex CLI.

Gemini CLI Command

Text

gemini --output-format text --model gemini-2.5-flash --yolo

Shell command used to launch Gemini CLI.

Claude CLI Command

Text

claude

Shell command used to launch Claude CLI.

Copilot CLI Command

Text

copilot

Shell command used to launch Copilot CLI.

OpenCode CLI Command

Text

opencode

Shell command used to launch OpenCode CLI.

Ollama URL

Text

http://127.0.0.1:11434

Base URL for Ollama API.

Ollama Model

Text

llama3.1

Model identifier sent to Ollama.

Ollama API Key

Text

(empty)

Optional bearer token for Ollama-compatible servers.

Ollama Extra Headers

Multiline

(empty)

Extra headers, one per line (Header: value).

Ollama Auto-Start

Toggle

On

Auto-start ollama serve when backend is selected.

Ollama Serve Command

Text

ollama serve

Command used for Ollama server startup.

Ollama Timeout

Number

120

Timeout in seconds (range: 30-3600).

Ollama Context Window

Number

8192

Context window size (persisted in range 2048-128000; loaded values up to 256000 are accepted).

LM Studio URL

Text

http://127.0.0.1:1234

Base URL for LM Studio API.

LM Studio Model

Text

lmstudio

Model identifier sent to LM Studio.

LM Studio API Key

Text

(empty)

Optional bearer token for OpenAI-compatible servers.

LM Studio Extra Headers

Multiline

(empty)

Extra headers, one per line (Header: value).

LM Studio Auto-Start

Toggle

On

Auto-start LM Studio server command.

LM Studio Server Command

Text

lms server start

Command used for LM Studio startup.

LM Studio Timeout

Number

120

Timeout in seconds (range: 30-3600).

OpenAI-Compatible URL

Text

(empty)

Base URL for OpenAI-compatible providers.

OpenAI-Compatible Model

Text

(empty)

Model identifier sent in requests.

OpenAI-Compatible API Key

Text

(empty)

Optional bearer token.

OpenAI-Compatible Extra Headers

Multiline

(empty)

Extra headers, one per line (Header: value).

OpenAI-Compatible Timeout

Number

120

Timeout in seconds (range: 30-3600).

NVIDIA NIM URL

Text

https://integrate.api.nvidia.com

Base URL for NVIDIA NIM endpoints.

NVIDIA NIM Model

Text

(empty)

Model identifier (e.g. moonshotai/kimi-k2.5).

NVIDIA NIM API Key

Text

(empty)

Bearer token for NVIDIA NIM.

NVIDIA NIM Extra Headers

Multiline

(empty)

Extra headers, one per line (Header: value).

NVIDIA NIM Timeout

Number

60

Timeout in seconds (range: 30-3600).

Perplexity URL

Text

https://api.perplexity.ai

Base URL for Perplexity Sonar endpoints. Targets /chat/completions directly (no /v1 prefix).

Perplexity Model

Text

(empty)

Sonar model identifier (e.g. sonar-pro, sonar-reasoning-pro).

Perplexity API Key

Text

(empty)

pplx-… bearer token.

Perplexity Extra Headers

Multiline

(empty)

Extra headers, one per line (Header: value).

Perplexity Timeout

Number

60

Timeout in seconds (range: 30-3600).

Auto-Restart

Toggle

On

Automatically restart crashed CLI backends.

Agent Profile

Dropdown

pentester

Active profile from ~/.burp-ai-agent/AGENTS/*.md.

Small model mode

Toggle

Off

Caps chat context to roughly 1500/750 characters per request/response so small local models are not overflowed. Setting key smallModelMode.

Privacy & Logging

Setting
Type
Default
Description

Privacy Mode

Dropdown

BALANCED

Redaction policy (STRICT, BALANCED, OFF). Users who previously chose OFF explicitly keep their choice on upgrade.

Determinism Mode

Toggle

Off

Stabilizes ordering for reproducible prompt bundles.

Host Anonymization Salt

Text

(auto-generated)

Secret used to produce stable host pseudonyms in STRICT mode.

Audit Logging

Toggle

Off

Enables JSONL audit log at ~/.burp-ai-agent/audit.jsonl.

AI Request Logger

Toggle

On

Enables real-time AI activity logging in the AI Logger tab.

AI Logger Max Entries

Number

500

Maximum entries in the in-memory logger buffer (range: 10+).

MCP Server

Setting
Type
Default
Description

Enable MCP

Toggle

Off

Start MCP SSE server when extension loads. Off by default — turn it on before connecting external clients.

Host

Text

127.0.0.1

Bind address.

Port

Number

9876

TCP port for MCP server.

External Access

Toggle

Off

Allow non-loopback connections. Requires TLS and a bearer token.

Restrict to in-scope hosts

Toggle

Off

When on, every scope-aware MCP tool (proxy history, site map, request senders, scanner, …) rejects targets outside Burp's defined scope, so an external MCP client cannot reach out-of-scope hosts through Burp. Setting key mcpScopeOnly.

STDIO Bridge

Toggle

Off

Enable stdio transport in addition to SSE.

Token

Text

(auto-generated)

Bearer token used for external access and for the POST /__mcp/shutdown endpoint. Persisted under preferences key mcp.token.

Allowed Origins

Multiline

(empty)

Comma-, semicolon-, or newline-separated list of Origin/Host patterns to accept in addition to loopback. Leave empty to restrict to loopback.

TLS Enabled

Toggle

Off

Enable HTTPS for MCP server.

Auto-Generate Certificate

Toggle

On

Generate self-signed PKCS12 keystore automatically via JDK keytool (RSA 2048, 365 days, CN=burp-mcp).

Keystore Path

Text

~/.burp-ai-agent/certs/mcp-keystore.p12

Custom PKCS12 path for TLS mode.

Keystore Password

Text

(auto-generated)

Password used by custom keystore. Persisted under preferences key mcp.tls.keystore.password.

Max Concurrent Requests

Number

4

Max parallel MCP tool calls (range: 1-64).

Max body size (KB)

Number

2048

Maximum MCP tool output body size per item, in KB (range: 32-102400).

Scan Task TTL (min)

Number

120

Retention for completed scan task references surfaced via MCP (range: 5-1440).

Collaborator Client TTL (min)

Number

60

Retention for Collaborator secret keys allocated by MCP (range: 5-1440).

Enable Unsafe Tools

Toggle

Off

Master switch for tools marked unsafe.

MCP Proxy History Preprocessing

Applies to MCP tools that surface Burp proxy history (proxy_http_history, proxy_http_history_regex, response_body_search).

Setting
Type
Default
Description

Preprocess proxy history

Toggle

On

Master switch for the preprocessing pipeline.

Filter binary content

Toggle

On

Drop responses whose content type is binary (images, archives, fonts, etc.).

Max response body size (KB)

Number

20

Truncate responses above this size before returning them to MCP clients (range: 1-10240).

Allowed content types

Multiline

text/, application/json, application/xml, application/javascript, application/x-www-form-urlencoded, multipart/form-data

Content types that bypass the binary filter.

Max items per request

Number

20

Upper bound on proxy history entries returned per tool call (range: 1-500).

Newest first

Toggle

On

Return the most recent proxy entries first.

Allow unpreprocessed history

Toggle

On

Expose a raw variant of the tool alongside the preprocessed one for clients that need the original payloads.

Burp Integration

This is the redesigned MCP Tools tab. Tools are grouped into extension-native (AI) tools and generic (Montoya) tools, each tagged with the build it ships in (store-build vs full-build), with a search/filter box and per-group bulk toggles. The full build registers all 59 MCP tools; the BApp Store build registers only the 8 extension-native AI tools (status, issue_create, ai_analyze, ai_passive_scan, ai_findings_recent, redact_preview, ai_audit_query, ai_backends_list).

Setting
Type
Default
Description

Tool Toggles

Checkboxes

(varies)

Enable/disable MCP tools per group, individually or with the per-group bulk toggle.

Passive AI Scanner

Setting
Type
Default
Description

Enabled

Toggle

Off

Enable background passive analysis.

Rate Limit

Number

5

Minimum seconds between analysis requests (range: 1-60).

Scope Only

Toggle

On

Analyze only targets in Burp scope.

Max Size (KB)

Number

96

Maximum response size eligible for passive analysis (range: 16-1024).

Min Severity

Dropdown

LOW

Ignore findings below selected severity.

Endpoint dedup (min)

Number

30

Skip repeated equivalent endpoint analysis inside window (range: 1-240).

Response dedup (min)

Number

30

Skip repeated response-fingerprint analysis inside window (range: 1-240).

Prompt cache TTL (min)

Number

30

Reuse parsed AI results for identical prompts inside window (range: 1-240).

Prompt cache entries

Number

500

Maximum prompt-result cache entries (range: 50-5000).

Endpoint cache entries

Number

5000

Maximum endpoint dedup cache entries (range: 100-50000).

Fingerprint cache entries

Number

5000

Maximum response-fingerprint dedup cache entries (range: 100-50000).

Req body chars (AI)

Number

2000

Maximum request body chars included in passive AI metadata (range: 256-20000).

Resp body chars (AI)

Number

4000

Maximum response body chars included in passive AI metadata (range: 512-40000).

Max headers

Number

40

Maximum filtered headers included in passive AI metadata (range: 5-120).

Max params

Number

15

Maximum parameters included in passive AI metadata (range: 5-100).

Req body chars (manual)

Number

4000

Maximum request body chars included by manual context actions (range: 256-40000).

Resp body chars (manual)

Number

8000

Maximum response body chars included by manual context actions (range: 512-80000).

Manual context JSON

Toggle

On (compact)

Use compact JSON serialization for context-menu actions.

Excluded extensions

Text

css,js,jpg,jpeg,png,gif,svg,ico,woff,woff2,ttf,eot,otf,mp4,mp3,avi,mov,webm,webp,pdf,zip,gz,tar,rar,7z,map,bmp,tif,tiff

Comma-separated file extensions to skip in passive scanning. Reduces API calls by skipping static assets.

Batch size (1=off)

Number

3

Group N requests per AI call for batch analysis (range: 1-5). Set to 1 to disable.

Persistent cache

Toggle

On

Cache AI results to disk (~/.burp-ai-agent/cache/) for reuse across Burp sessions.

Persistent TTL (hrs)

Number

24

Hours before persistent disk cache entries expire (range: 1-168).

Persistent max (MB)

Number

50

Maximum disk space for persistent cache in MB (range: 10-500). LRU eviction at 80% capacity.

Active AI Scanner

Setting
Type
Default
Description

Enabled

Toggle

Off

Enable active vulnerability testing.

Max Concurrent Scans

Number

3

Parallel active scans (range: 1-10).

Max Payloads per Point

Number

10

Payload variants per injection point (range: 1-50).

Timeout

Number

30

Timeout in seconds per scan request (range: 5-120).

Request Delay

Number

100

Delay between requests in ms (range: 0-5000).

Max Risk Level

Dropdown

SAFE

Maximum payload risk (SAFE, MODERATE, DANGEROUS).

Scope Only

Toggle

On

Scan only in-scope targets.

Scan Mode

Dropdown

FULL

Vulnerability-class strategy (BUG_BOUNTY, PENTEST, FULL).

Auto-Queue from Passive

Toggle

On

Queue high-confidence passive findings into active scanner.

Use Collaborator (OAST)

Toggle

Off

Enable out-of-band tests using Burp Collaborator.

AI Adaptive Payloads

Toggle

Off

Generate context-aware payloads using AI based on detected tech stack and error patterns from the Knowledge Base.

Prompt Templates

Built-In Templates

Setting
Type
Description

Find Vulnerabilities

Text area

Prompt for Find vulnerabilities request action.

Analyze this request

Text area

Prompt for compact endpoint summary.

Explain JS

Text area

Prompt for JavaScript analysis.

Access Control

Text area

Prompt for authorization test planning.

Login Sequence

Text area

Prompt for login flow extraction.

Analyze this Issue

Text area

Prompt for scanner issue analysis.

Generate PoC & Validate

Text area

Prompt for proof-of-concept generation.

Impact & Severity

Text area

Prompt for impact and severity assessment.

Full Report

Text area

Prompt for complete report generation.

BountyPrompt Integration

Setting
Type
Default
Description

Enable BountyPrompt actions

Toggle

Off

Enables curated BountyPrompt submenu actions in request/response context menus.

Prompt directory

Text

~/Tools/BountyPrompt/prompts

Directory containing BountyPrompt JSON files.

Auto-create issues

Toggle

On

Auto-create Burp issues for parsed findings from outputType = issue prompts.

Issue confidence threshold

Number

90

Minimum parsed confidence (0-100) required for issue creation.

Enabled prompt IDs

Multi-line text

Curated IDs

Allowlist of prompt IDs, comma- or newline-separated.

Default curated IDs:

  • API_Keys_Exposure_Detection

  • CSRF_Vulnerability_Assessment

  • Security_Headers_Analysis

  • Vulnerable_Software_Detection

  • Extract_Endpoints

  • Vulnerable_File_Upload_Endpoint_Detection

  • Web_Attack_Suggestions

  • Sensitive_Error_Messages_Detection

Custom Prompts

Dedicated settings tab that owns the saved free-form prompt library surfaced through the right-click Custom prompts submenu. The library persists globally (not per Burp project) as JSON. Malformed JSON loads as an empty library with an entry in Burp's extension log. Saving from this tab reflects in right-click menus immediately — no Burp restart required.

Library Entries

Each entry stores:

Field
Type
Description

id

UUID

Stable identifier. Used by Import to merge updates in place.

title

Text

Menu label and session-title stem. Truncated to 50 chars in the submenu.

promptText

Text (multiline)

Free-form user prompt sent to the backend. No variable substitution.

tags

Set

Subset of HTTP_SELECTION, SCANNER_ISSUE. Determines which context menus expose the entry.

showInContextMenu

Toggle

Master visibility switch. Hidden entries stay in the library but are not exposed in menus.

isFavorite

Toggle (★)

When true, pins the entry to the top of its context-menu group. Favorites keep their relative order; non-favorites follow.

Editor Controls

Control
Description

Add

Create a new entry with a generated UUID.

Edit

Modify the selected entry in place.

Duplicate

Copy the selected entry under a new UUID; " (copy)" is appended to the title.

Delete

Remove the selected entry.

Move Up / Move Down

Reorder. List order is the menu order — no auto-sort. Cross-group moves between favorites and non-favorites are blocked.

Favorite (★)

Pin/unpin the selected entry. Favorites appear above non-favorites in every context menu.

Search

Live filter on the editor table. Case-insensitive substring match against title and promptText. Clears with one click.

Import JSON

Read a JSON file and merge entries into the library by id. Existing IDs are updated in place; new IDs are appended. Duplicate IDs within the import payload are de-duplicated.

Export JSON

Write the entire library to a JSON file (pretty-printed, sorted keys per entry).

File Locations

The extension stores runtime files under ~/.burp-ai-agent/.

File/Directory
Purpose

~/.burp-ai-agent/audit.jsonl

JSONL audit entries with a per-event SHA-256 hash over the serialized payload (no chain).

~/.burp-ai-agent/bundles/

Prompt bundle snapshots for deterministic workflows.

~/.burp-ai-agent/contexts/

Context snapshot JSON files indexed by hash.

~/.burp-ai-agent/certs/

Auto-generated TLS artifacts for MCP server.

~/.burp-ai-agent/cache/

Persistent prompt cache (JSON files keyed by prompt hash). Per-project namespaced.

Burp extensionData()

Project-scoped chat session storage (auto-migrated from global preferences()).

~/.burp-ai-agent/backends/

Drop-in backend JAR discovery directory.

~/.burp-ai-agent/AGENTS/

Agent profile markdown files.

~/.burp-ai-agent/AGENTS/default

Active profile marker file.

~/.burp-ai-agent/logs/

Rolling AI Request Logger JSONL files (opt-in).

Runtime Constants

Some limits are operational constants rather than direct UI controls:

  • Auto tool chain limit: 8 sequential MCP tool calls per chat interaction.

  • Active scanner queue max: 2000 targets.

  • Active dedup window: 1 hour.

  • Passive analysis wait timeout: 90s.

  • HTTP backend conversation history cap: 20 messages and 40000 total characters (minimum 2 latest messages retained).

  • CLI history cap: 10 messages or 20000 characters.

  • Large prompt threshold for Claude CLI / Copilot CLI fallback path: 32000 characters.

  • HTTP backend retry schedule: 6 attempts with a fixed stepped backoff — 500 / 1000 / 1500 / 2000 / 3000 / 4000 ms (not exponential, capped at 4 s).

  • HTTP backend circuit breaker: opens after 5 consecutive failures, resets to half-open after 30000 ms, single half-open probe before closing or reopening.

  • OpenCode CLI idle timeout: 30s before process termination after last output.

  • CHAT_MAX_OUTPUT_TOKENS: 4096 — max output tokens for chat responses.

  • SCANNER_MAX_OUTPUT_TOKENS: 2048 — max output tokens for single scanner analysis.

  • SCANNER_BATCH_MAX_OUTPUT_TOKENS: 4096 — max output tokens for batch scanner analysis.

  • PAYLOAD_MAX_OUTPUT_TOKENS: 1024 — max output tokens for adaptive payload generation.

Rolling Log Persistence (JVM Properties)

The AI Request Logger can persist entries to rotating JSONL files. This is configured via JVM system properties at Burp startup:

Property
Default
Description

burp.ai.logger.rolling.enabled

false

Enable rolling file persistence.

burp.ai.logger.rolling.dir

~/.burp-ai-agent/logs

Directory for log files.

burp.ai.logger.rolling.maxBytes

1048576 (1 MB)

Maximum size per log file (minimum 10 KB).

burp.ai.logger.rolling.maxFiles

5

Maximum number of rolled files (range: 1–20).

Example:

Last updated