Skip to main content

Model Context Protocol server for SpiderFoot OSINT automation

Project description

SpiderFoot MCP Server

A Model Context Protocol (MCP) server that provides SpiderFoot OSINT automation capabilities to AI assistants and other MCP clients.

Installation

pip install spiderfoot-mcp

Configuration

Set the following environment variables or create a .env file:

SPIDERFOOT_URL=http://localhost:5001
SPIDERFOOT_USERNAME=admin
SPIDERFOOT_PASSWORD=your_password

Usage

As MCP Server

Start the MCP server:

spiderfoot-mcp

The server will expose SpiderFoot functionality as MCP tools that can be used by AI assistants.

Available Tools

The MCP server provides the following tools:

  • start_scan: Start a new SpiderFoot scan
  • get_scan_status: Get the current status of a scan
  • list_scans: List all scans on the server
  • stop_scan: Stop a running scan
  • delete_scan: Delete a scan and its data
  • get_scan_results: Get results from a scan
  • get_scan_summary: Get a summary of scan results
  • wait_for_scan_completion: Wait for a scan to complete
  • export_scan_results: Export scan results in various formats
  • get_available_modules: Get list of available SpiderFoot modules
  • search_scan_results: Search across scan results
  • get_scan_log: Get log entries for a scan
  • get_active_scans_summary: Get summary of tracked scans
  • ping: Test connectivity to SpiderFoot server

MCP Client Configuration

To use this server with Claude Desktop or other MCP clients, add the following to your MCP configuration:

{
  "mcpServers": {
    "spiderfoot": {
      "command": "spiderfoot-mcp",
      "env": {
        "SPIDERFOOT_URL": "http://localhost:5001",
        "SPIDERFOOT_USERNAME": "admin",
        "SPIDERFOOT_PASSWORD": "your_password"
      }
    }
  }
}

Requirements

  • Python 3.8+
  • spiderfoot-client>=1.0.0
  • fastmcp>=2.10.0
  • python-dotenv>=1.0.0
  • A running SpiderFoot instance

Dependencies

This package depends on the spiderfoot-client package, which provides the underlying SpiderFoot API client functionality.

License

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

spiderfoot_mcp-1.0.0.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

spiderfoot_mcp-1.0.0-py3-none-any.whl (6.8 kB view details)

Uploaded Python 3

File details

Details for the file spiderfoot_mcp-1.0.0.tar.gz.

File metadata

  • Download URL: spiderfoot_mcp-1.0.0.tar.gz
  • Upload date:
  • Size: 7.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for spiderfoot_mcp-1.0.0.tar.gz
Algorithm Hash digest
SHA256 ae1b7186f13d2a1100c051ff04cb2a00f9da383e2e484603e9cdf9e5bf62b186
MD5 d306d9b00bdea32abf2bacc7c8f36266
BLAKE2b-256 dce0a98aede5d42eae4a97c4dedc3bc3cc90efd18599f8733785f3b0c74be4e0

See more details on using hashes here.

File details

Details for the file spiderfoot_mcp-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: spiderfoot_mcp-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 6.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for spiderfoot_mcp-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b7e2e0aaf6cf27b9403f7419b36d4acf4fe06bdd98b6a5b1086c934ba2683477
MD5 4716652b07f838ed3d74aeaa6ae191fc
BLAKE2b-256 68a8a04602305f2c8a8d45685e73087053fd0bcf5ce7a6214cfb1a4357050b9f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page