Package burp.mcp.tool

Interface Tool

All Known Implementing Classes:
BurpInfoTool, BurpMetricsTool, CollaboratorGeneratePayloadTool, CollaboratorInteractionsTool, ConfigGetTool, ConfigListPreferencesTool, ConfigSetTool, CookieListTool, CookieSetTool, DecoderDecodeTool, DecoderEncodeTool, HttpBuildRequestTool, HttpDiffResponsesTool, HttpGetRequestTool, HttpKeywordSearchTool, HttpModifyRequestTool, HttpParseRequestTool, HttpParseResponseTool, HttpSendRequestsTool, HttpSendRequestTool, HttpSendToComparerTool, HttpSendToDecoderTool, HttpSendToIntruderTool, HttpSendToOrganizerTool, HttpSendToRepeaterTool, HttpStoreRequestTool, LoggerAddTool, OrganizerListTool, ProjectCreateTool, ProxyHistoryGetTool, ProxyHistoryListTool, ProxyInterceptStatusTool, ProxyToggleInterceptTool, ProxyWebSocketHistoryTool, ScannerBcheckImportTool, ScannerCrawlStatusTool, ScannerCrawlStopTool, ScannerGenerateReportTool, ScannerGetIssueTool, ScannerIssuesListFilteredTool, ScannerIssuesListTool, ScannerStartAuditTool, ScannerStartCrawlTool, ScopeCheckTool, ScopeListTool, ScopeSetTool, SitemapGetTool, SitemapListFilteredTool, SitemapListTool, SitemapSearchTool, TaskEngineSetTool, TaskEngineStatusTool, WebSocketHistoryGetTool
public interface Tool
Common interface for all MCP tools.

  • 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.

  • Method Details

    • definition

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

    • execute

      Object execute(Map<String,Object> args)
      Execute the tool with the given arguments.
      Parameters:
      args - The tool arguments as a Map
      Returns:
      The tool result as a Map (will be serialized to JSON)

    • inputSchema

      com.fasterxml.jackson.databind.node.ObjectNode inputSchema()
      The JSON schema for the tool's input parameters.