Package burp.mcp.tool

Class ScannerCrawlStatusTool

java.lang.Object

burp.mcp.tool.ScannerBase

burp.mcp.tool.ScannerCrawlStatusTool

All Implemented Interfaces:

Tool

public class ScannerCrawlStatusTool
extends ScannerBase
implements Tool

Poll progress of a crawl started with scanner_start_crawl. Uses the request/error counters (implemented) rather than the status text (unimplemented by Burp).

Field Summary

Fields inherited from class burp.mcp.tool.ScannerBase

api

Constructor Summary

Constructors

Constructor	Description
ScannerCrawlStatusTool(burp.api.montoya.MontoyaApi api)

Method Summary

Modifier and Type	Method	Description
ToolDefinition	definition()	Returns the tool's metadata (name, description, input schema).
Object	execute(Map<String,Object> args)	Execute the tool with the given arguments.
com.fasterxml.jackson.databind.node.ObjectNode	inputSchema()	The JSON schema for the tool's input parameters.

Methods inherited from class burp.mcp.tool.ScannerBase

checkProEdition

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ScannerCrawlStatusTool

public ScannerCrawlStatusTool(burp.api.montoya.MontoyaApi api)

Method Details

definition

public ToolDefinition definition()

Description copied from interface: Tool

Returns the tool's metadata (name, description, input schema).

Specified by:

definition in interface Tool

inputSchema

public com.fasterxml.jackson.databind.node.ObjectNode inputSchema()

Description copied from interface: Tool

The JSON schema for the tool's input parameters.

Specified by:

inputSchema in interface Tool

execute

public Object execute(Map<String,Object> args)

Description copied from interface: Tool

Execute the tool with the given arguments.

Specified by:

execute in interface Tool

Parameters:

args - The tool arguments as a Map

Returns:

The tool result as a Map (will be serialized to JSON)