Package burp.mcp.tool

Class ProjectCreateTool

java.lang.Object
burp.mcp.tool.ProjectCreateTool
All Implemented Interfaces:
Tool
public class ProjectCreateTool extends Object implements Tool
How to create a new Burp project via the Burp executable.

The Montoya API exposes the current project read-only (name()/id()), so a new project cannot be created from inside Burp. The supported path is launching the Burp executable with --project-file, which creates the file as a new project when it does not exist yet (verified against BurpSuite --help).

This tool performs no side effects — it returns the exact command to run yourself outside Burp, plus useful flags and caveats.

  • Constructor Details

    • ProjectCreateTool

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