Skip to main content
Glama

zap.get_sites

Retrieve discovered websites from OWASP ZAP for security testing and vulnerability assessment in bug bounty hunting workflows.

Instructions

Get list of discovered sites from ZAP

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • MCP tool handler for 'zap.get_sites': retrieves the ZAP client instance and calls its getSites() method, handling errors and formatting the result using formatToolResult.
    async (): Promise<ToolResult> => {
      const client = getZAPClient();
      if (!client) {
        return formatToolResult(false, null, 'ZAP client not initialized');
      }
      const result = await client.getSites();
      return formatToolResult(result.success, result.data, result.error);
    }
  • Core helper method ZAPClient.getSites(): queries the ZAP API endpoint '/core/view/sites/' via axios to fetch discovered sites tree.
    async getSites(): Promise<ZAPScanResult> {
      try {
        const response = await this.client.get('/core/view/sites/');
        return {
          success: true,
          data: {
            sites: response.data.sites || [],
          },
        };
      } catch (error: any) {
        return {
          success: false,
          error: error.message || 'Failed to get sites',
        };
      }
    }
  • Registers the 'zap.get_sites' tool with the MCP server inside registerZAPTools function, providing schema and handler.
    server.tool(
      'zap.get_sites',
      {
        description: 'Get list of discovered sites from ZAP',
        inputSchema: {
          type: 'object',
          properties: {},
        },
      },
      async (): Promise<ToolResult> => {
        const client = getZAPClient();
        if (!client) {
          return formatToolResult(false, null, 'ZAP client not initialized');
        }
        const result = await client.getSites();
        return formatToolResult(result.success, result.data, result.error);
      }
    );
  • Input schema for 'zap.get_sites': requires no parameters (empty properties). Includes tool description.
    {
      description: 'Get list of discovered sites from ZAP',
      inputSchema: {
        type: 'object',
        properties: {},
      },
    },
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It states the action ('Get list') but doesn't describe what 'discovered sites' means, whether this is a read-only operation, if it requires authentication, or how results are formatted. For a tool with zero annotation coverage, this is a significant gap in transparency.

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 a single, efficient sentence with no wasted words. It's front-loaded with the core action and resource, making it easy to parse quickly. Every word earns its place by conveying essential information.

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

Completeness3/5

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

Given the tool has 0 parameters, no output schema, and no annotations, the description is minimally adequate but incomplete. It states what the tool does but lacks details on behavior, output format, or differentiation from siblings. For a simple retrieval tool, it's passable but leaves gaps an agent would need to infer.

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

Parameters4/5

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

The tool has 0 parameters, and the input schema has 100% description coverage (though empty). The description doesn't need to explain parameters, so it meets the baseline expectation. No additional parameter information is required or provided.

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 verb ('Get') and resource ('list of discovered sites from ZAP'), making the purpose immediately understandable. However, it doesn't differentiate from sibling tools like 'zap.get_urls' or 'zap.get_alerts', which also retrieve data from ZAP, leaving some ambiguity about what specifically distinguishes this tool.

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?

The description provides no guidance on when to use this tool versus alternatives. With siblings like 'zap.get_urls' and 'zap.get_alerts' that also retrieve ZAP data, there's no indication of context, prerequisites, or exclusions, leaving the agent to guess based on tool names alone.

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/telmon95/VulneraMCP'

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