Skip to main content
Glama
CorbettCajun

SpiderFoot MCP Server

Scan Data

spiderfoot_scan_data

Retrieve scan event results for a specific scan ID to analyze reconnaissance data from SpiderFoot OSINT investigations.

Instructions

Fetch scan event results for a scan ID.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
eventTypeNo

Implementation Reference

  • Core handler logic for fetching scan event results via HTTP POST to SpiderFoot API endpoint '/scaneventresults'. This is called by the tool's wrapper handler.
    async scanEventResults(args: { id: string; eventType?: string }) {
      const { data } = await this.http.post('/scaneventresults', {
        id: args.id,
        eventType: args.eventType ?? 'ALL',
      });
      return data;
    }
  • src/index.ts:82-86 (registration)
    Tool registration for 'spiderfoot_scan_data' in the stdio MCP server, including input schema (id: string, optional eventType) and handler wrapper.
    server.registerTool(
      'spiderfoot_scan_data',
      { title: 'Scan Data', description: 'Fetch scan event results for a scan ID.', inputSchema: { id: z.string(), eventType: z.string().optional() } },
      async ({ id, eventType }) => ({ content: [{ type: 'text', text: JSON.stringify(await sf.scanEventResults({ id, eventType })) }] })
    );
  • Tool registration for 'spiderfoot_scan_data' in the HTTP MCP server, identical to stdio version.
    server.registerTool(
      'spiderfoot_scan_data',
      { title: 'Scan Data', description: 'Fetch scan event results for a scan ID.', inputSchema: { id: z.string(), eventType: z.string().optional() } },
      async ({ id, eventType }) => ({ content: [{ type: 'text', text: JSON.stringify(await sf.scanEventResults({ id, eventType })) }] })
    );
  • Zod schema for scan data input parameters, matching the tool's inputSchema (though registration uses slightly relaxed version without min(1)).
    const ScanDataSchema = z.object({
      id: z.string().min(1),
      eventType: z.string().optional(),
    });
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It states it 'fetches' results, implying a read-only operation, but doesn't specify if it requires authentication, has rate limits, returns paginated data, or what the output format is (e.g., JSON, raw text). This leaves significant gaps for a tool that retrieves data.

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, direct sentence with no wasted words. It's front-loaded with the core action ('Fetch scan event results') and condition ('for a scan ID'), making it efficient and easy to parse.

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 the complexity (2 parameters, no annotations, no output schema), the description is incomplete. It doesn't explain the return values, error conditions, or behavioral traits like data format or access requirements. For a data-fetching tool with undocumented parameters, this minimal description is insufficient.

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

Parameters2/5

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

The schema has 0% description coverage, so the description must compensate. It mentions 'scan ID' which maps to the 'id' parameter, but doesn't explain the 'eventType' parameter at all (e.g., what types are available, if it's optional for filtering). This partial coverage fails to fully clarify the parameters beyond the schema.

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 ('Fetch') and resource ('scan event results') with a specific condition ('for a scan ID'), making the purpose understandable. However, it doesn't explicitly differentiate from sibling tools like 'spiderfoot_scan_data_unique' or 'spiderfoot_scan_logs', which likely also retrieve scan-related data.

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. It doesn't mention prerequisites (e.g., needing an existing scan ID), exclusions, or comparisons to siblings like 'spiderfoot_scan_data_unique' for unique results or 'spiderfoot_scan_logs' for logs, leaving the agent to infer usage from context 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/CorbettCajun/Spiderfoot-MCP-Server'

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