Skip to main content
Glama
CorbettCajun

SpiderFoot MCP Server

Scan Logs

spiderfoot_scan_logs

Retrieve scan execution logs for a specific SpiderFoot OSINT reconnaissance scan to monitor progress, track events, and analyze data collection activities.

Instructions

Fetch/poll scan logs for a given scan ID.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
limitNo
reverseNo
rowIdNo

Implementation Reference

  • Core implementation of the scanLogs functionality: sends a POST request to the Spiderfoot server's /scanlog endpoint with the provided parameters and returns the response data.
    async scanLogs(args: { id: string; limit?: number; reverse?: '0' | '1'; rowId?: number }) {
      const { data } = await this.http.post('/scanlog', {
        id: args.id,
        limit: args.limit,
        reverse: args.reverse,
        rowId: args.rowId,
      });
      return data;
    }
  • Zod schema defining the input parameters for the spiderfoot_scan_logs tool.
    const ScanLogsSchema = z.object({
      id: z.string().min(1),
      limit: z.number().int().positive().optional(),
      reverse: z.enum(['0', '1']).optional(),
      rowId: z.number().int().nonnegative().optional(),
    });
  • src/index.ts:94-98 (registration)
    Registers the 'spiderfoot_scan_logs' tool on the MCP server (stdio transport), providing title, description, input schema, and handler that delegates to sf.scanLogs.
    server.registerTool(
      'spiderfoot_scan_logs',
      { title: 'Scan Logs', description: 'Fetch/poll scan logs for a given scan ID.', inputSchema: { id: z.string(), limit: z.number().optional(), reverse: z.enum(['0','1']).optional(), rowId: z.number().optional() } },
      async ({ id, limit, reverse, rowId }) => ({ content: [{ type: 'text', text: JSON.stringify(await sf.scanLogs({ id, limit, reverse, rowId })) }] })
    );
  • Registers the 'spiderfoot_scan_logs' tool on the MCP server (HTTP transport), identical to the stdio version.
    server.registerTool(
      'spiderfoot_scan_logs',
      { title: 'Scan Logs', description: 'Fetch/poll scan logs for a given scan ID.', inputSchema: { id: z.string(), limit: z.number().optional(), reverse: z.enum(['0','1']).optional(), rowId: z.number().optional() } },
      async ({ id, limit, reverse, rowId }) => ({ content: [{ type: 'text', text: JSON.stringify(await sf.scanLogs({ id, limit, reverse, rowId })) }] })
    );
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 mentions 'fetch/poll', suggesting it might retrieve or monitor logs, but fails to clarify key traits such as whether this is a read-only operation, potential side effects, authentication needs, rate limits, or the format of returned logs. This is inadequate for a tool with multiple parameters and no output schema.

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 that directly states the tool's function without unnecessary words. It is front-loaded and appropriately sized, making it easy to parse quickly.

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 (4 parameters, no annotations, no output schema), the description is incomplete. It lacks details on behavioral traits, parameter purposes beyond 'id', and what the tool returns (e.g., log format or structure). This leaves significant gaps for the agent to understand and use the tool effectively.

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 description coverage is 0%, so the description must compensate, but it only references the 'id' parameter ('for a given scan ID') and ignores 'limit', 'reverse', and 'rowId'. This adds minimal meaning beyond the schema, leaving most parameters undocumented and their purposes unclear to the agent.

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 ('fetch/poll') and resource ('scan logs') with a specific scope ('for a given scan ID'), making the purpose understandable. However, it doesn't differentiate from siblings like 'spiderfoot_scan_data' or 'spiderfoot_scan_info', which might also retrieve scan-related information, so it doesn't fully distinguish itself.

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 minimal guidance by implying usage when logs for a specific scan ID are needed, but it offers no explicit advice on when to use this tool versus alternatives (e.g., 'spiderfoot_scan_data' or 'spiderfoot_scan_info'), prerequisites, or exclusions. This leaves the agent with insufficient context for optimal selection.

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