Package burp.mcp.tool

Class ScopeListTool

java.lang.Object
burp.mcp.tool.ScopeListTool
All Implemented Interfaces:
Tool
public class ScopeListTool extends Object implements Tool
Lists the target scope from two angles:
  • configured_scope — the actual include rules from Burp's project configuration, so includes show up even with an empty sitemap.
  • urls/count — in-scope URLs observed in sitemap traffic.

  • Constructor Details

    • ScopeListTool

      public ScopeListTool(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)