Skip to main content
Glama

burp_export

Export Burp Suite security scan results in XML, HTML, or JSON formats for analysis and reporting during penetration testing.

Instructions

Export Burp Suite scan results

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
formatNoExport format (default: xml)
output_pathNoOutput file path (optional)

Implementation Reference

  • Core handler function that performs the burp_export tool logic: fetches scan report from Burp API and saves to file in specified format.
    async exportResults(format: 'xml' | 'html' | 'json' = 'xml', outputPath?: string): Promise<ScanResult> {
      try {
        console.error(`📄 Exporting Burp results in ${format} format`);
    
        const exportResponse = await axios.get(`${this.apiBaseUrl}/v0.1/scan/report`, {
          params: { format }
        });
    
        const timestamp = new Date().toISOString().replace(/[:.]/g, '-');
        const filename = outputPath || `burp-report-${timestamp}.${format}`;
        
        fs.writeFileSync(filename, exportResponse.data);
    
        return {
          target: 'export',
          timestamp: new Date().toISOString(),
          tool: 'burpsuite_export',
          results: {
            export_format: format,
            output_file: filename,
            file_size: fs.statSync(filename).size
          },
          status: 'success'
        };
    
      } catch (error) {
        return {
          target: 'export',
          timestamp: new Date().toISOString(),
          tool: 'burpsuite_export',
          results: {},
          status: 'error',
          error: error instanceof Error ? error.message : String(error)
        };
      }
    }
  • src/index.ts:607-608 (registration)
    Dispatch handler in main server that routes 'burp_export' calls to BurpSuiteIntegration.exportResults method.
    case "burp_export":
      return respond(await this.burpSuite.exportResults(args.format || 'xml', args.output_path));
  • Tool schema definition and registration in the list of available tools, including input schema for parameters.
      name: "burp_export",
      description: "Export Burp Suite scan results",
      inputSchema: {
        type: "object",
        properties: {
          format: { 
            type: "string", 
            enum: ["xml", "html", "json"],
            description: "Export format (default: xml)" 
          },
          output_path: { type: "string", description: "Output file path (optional)" }
        },
        required: []
      }
    }
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries full burden but only states the basic action. It doesn't disclose behavioral traits like whether this is a read-only operation, what happens if no scan results exist, file system implications of 'output_path', or potential side effects. The description is minimal and lacks necessary context for safe use.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is extremely concise at just four words, front-loading the core purpose with zero wasted text. Every word earns its place by specifying the tool's essential function.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given no annotations, no output schema, and a mutation-suggesting tool ('Export'), the description is incomplete. It doesn't explain what gets exported, where from, what the output looks like, or error conditions. For a tool with potential file system impact, this leaves significant gaps for safe agent operation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents both parameters thoroughly. The description adds no additional meaning about parameters beyond what's in the schema (e.g., explaining format choices or typical output paths). Baseline 3 is appropriate when schema does the heavy lifting.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('Export') and resource ('Burp Suite scan results'), making the purpose immediately understandable. However, it doesn't differentiate from sibling tools like 'generate_report' or specify what exactly is being exported (e.g., raw data vs. formatted report).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance is provided on when to use this tool versus alternatives like 'generate_report' or other export-related tools. The description gives no context about prerequisites (e.g., needing existing scan results) or typical workflows.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/adriyansyah-mf/mcp-pentest'

If you have feedback or need assistance with the MCP directory API, please join our Discord server