# burp-ai-agent ## burp-ai-agent - [Overview](https://burp-ai-agent.six2dez.com/readme.md) - [Installation](https://burp-ai-agent.six2dez.com/getting-started/installation.md) - [Quick Start](https://burp-ai-agent.six2dez.com/getting-started/quick-start.md) - [First Run Checklist](https://burp-ai-agent.six2dez.com/getting-started/first-run-checklist.md) - [UI Tour](https://burp-ai-agent.six2dez.com/user-guide/ui-tour.md) - [Context Menus](https://burp-ai-agent.six2dez.com/user-guide/context-menus.md) - [Insertion Point Scan](https://burp-ai-agent.six2dez.com/user-guide/insertion-point-scan.md) - [Chat & Sessions](https://burp-ai-agent.six2dez.com/user-guide/chat-sessions.md) - [Prompt Templates](https://burp-ai-agent.six2dez.com/user-guide/prompt-templates.md) - [BountyPrompt Actions](https://burp-ai-agent.six2dez.com/user-guide/bountyprompt-actions.md) - [Agent Profiles](https://burp-ai-agent.six2dez.com/user-guide/agent-profiles.md) - [Burp Integration](https://burp-ai-agent.six2dez.com/user-guide/burp-integration.md) - [Token Usage & Cost Management](https://burp-ai-agent.six2dez.com/user-guide/token-management.md) - [Passive AI Scanner](https://burp-ai-agent.six2dez.com/scanners/passive.md) - [Active AI Scanner](https://burp-ai-agent.six2dez.com/scanners/active.md) - [Security Advisories](https://burp-ai-agent.six2dez.com/security/advisories.md) - [Privacy Modes](https://burp-ai-agent.six2dez.com/privacy-and-logging/privacy-modes.md) - [Limitations & Hallucinations](https://burp-ai-agent.six2dez.com/privacy-and-logging/limitations.md) - [Audit Logging](https://burp-ai-agent.six2dez.com/privacy-and-logging/audit-logging.md) - [AI Request Logger](https://burp-ai-agent.six2dez.com/privacy-and-logging/ai-request-logger.md) - [Determinism & Salt](https://burp-ai-agent.six2dez.com/privacy-and-logging/determinism-salt.md) - [Overview](https://burp-ai-agent.six2dez.com/backends/overview.md) - [Burp AI (Built-in)](https://burp-ai-agent.six2dez.com/backends/burp-ai.md) - [Ollama (Local)](https://burp-ai-agent.six2dez.com/backends/ollama.md) - [LM Studio (Local)](https://burp-ai-agent.six2dez.com/backends/lm-studio.md) - [NVIDIA NIM](https://burp-ai-agent.six2dez.com/backends/nvidia-nim.md) - [Perplexity](https://burp-ai-agent.six2dez.com/backends/perplexity.md) - [Anthropic (API)](https://burp-ai-agent.six2dez.com/backends/anthropic.md) - [Generic (OpenAI-compatible)](https://burp-ai-agent.six2dez.com/backends/openai-compatible.md) - [Backend Troubleshooting](https://burp-ai-agent.six2dez.com/backends/troubleshooting.md) - [Gemini CLI](https://burp-ai-agent.six2dez.com/backends/gemini-cli.md) - [Claude CLI](https://burp-ai-agent.six2dez.com/backends/claude-cli.md) - [Codex CLI](https://burp-ai-agent.six2dez.com/backends/codex-cli.md) - [Copilot CLI](https://burp-ai-agent.six2dez.com/backends/copilot-cli.md) - [OpenCode CLI](https://burp-ai-agent.six2dez.com/backends/opencode-cli.md) - [MCP Overview](https://burp-ai-agent.six2dez.com/mcp-server/overview.md) - [Security Model](https://burp-ai-agent.six2dez.com/mcp-server/security-model.md) - [Tools Reference](https://burp-ai-agent.six2dez.com/mcp-server/tools-reference.md) - [External MCP Servers](https://burp-ai-agent.six2dez.com/mcp-server/external-servers.md) - [Issue Creation (MCP)](https://burp-ai-agent.six2dez.com/mcp-server/issue-create.md) - [Typical Workflows](https://burp-ai-agent.six2dez.com/examples/typical-workflows.md) - [Sample Prompts](https://burp-ai-agent.six2dez.com/examples/sample-prompts.md) - [Recipes: How Do I…](https://burp-ai-agent.six2dez.com/examples/recipes.md) - [Burp Scan Skill (Terminal AI)](https://burp-ai-agent.six2dez.com/examples/burp-scan-skill.md) - [Settings Reference](https://burp-ai-agent.six2dez.com/reference/settings-reference.md) - [Prompt Defaults](https://burp-ai-agent.six2dez.com/reference/prompt-defaults.md) - [Best Practices & Hardening](https://burp-ai-agent.six2dez.com/reference/best-practices.md) - [FAQ](https://burp-ai-agent.six2dez.com/reference/faq.md) - [Glossary](https://burp-ai-agent.six2dez.com/reference/glossary.md) - [Configuration Directory](https://burp-ai-agent.six2dez.com/reference/configuration-directory.md) - [Troubleshooting](https://burp-ai-agent.six2dez.com/reference/troubleshooting.md) - [Architecture](https://burp-ai-agent.six2dez.com/developer/architecture.md) - [Data Flow](https://burp-ai-agent.six2dez.com/developer/data-flow.md) - [Redaction Pipeline](https://burp-ai-agent.six2dez.com/developer/redaction-pipeline.md) - [Supervisor & Backends](https://burp-ai-agent.six2dez.com/developer/supervisor-backends.md) - [Settings Migration](https://burp-ai-agent.six2dez.com/developer/settings-migration.md) - [Adding a Backend](https://burp-ai-agent.six2dez.com/developer/adding-backend.md) - [Adding MCP Tools](https://burp-ai-agent.six2dez.com/developer/adding-mcp-tools.md) - [Testing & Debugging](https://burp-ai-agent.six2dez.com/developer/testing.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 This site has an agentic ask interface you may use to query the documentation dynamically by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://burp-ai-agent.six2dez.com/index.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.