# SpiderFoot MCP Server
A Model Context Protocol (MCP) server that provides SpiderFoot OSINT automation capabilities to AI assistants and other MCP clients.
## Installation
```bash
pip install spiderfoot-mcp
```
## Configuration
Set the following environment variables or create a `.env` file:
```bash
SPIDERFOOT_URL=http://localhost:5001
SPIDERFOOT_USERNAME=admin
SPIDERFOOT_PASSWORD=your_password
```
## Usage
### As MCP Server
Start the MCP server:
```bash
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:
```json
{
"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
Raw data
{
"_id": null,
"home_page": null,
"name": "spiderfoot-mcp",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "spiderfoot, osint, security, mcp, model-context-protocol, reconnaissance",
"author": null,
"author_email": "Vlatko Kosturjak <vlatko.kosturjak@marlink.com>",
"download_url": "https://files.pythonhosted.org/packages/dc/e0/a98aede5d42eae4a97c4dedc3bc3cc90efd18599f8733785f3b0c74be4e0/spiderfoot_mcp-1.0.0.tar.gz",
"platform": null,
"description": "# SpiderFoot MCP Server\n\nA Model Context Protocol (MCP) server that provides SpiderFoot OSINT automation capabilities to AI assistants and other MCP clients.\n\n## Installation\n\n```bash\npip install spiderfoot-mcp\n```\n\n## Configuration\n\nSet the following environment variables or create a `.env` file:\n\n```bash\nSPIDERFOOT_URL=http://localhost:5001\nSPIDERFOOT_USERNAME=admin\nSPIDERFOOT_PASSWORD=your_password\n```\n\n## Usage\n\n### As MCP Server\n\nStart the MCP server:\n\n```bash\nspiderfoot-mcp\n```\n\nThe server will expose SpiderFoot functionality as MCP tools that can be used by AI assistants.\n\n### Available Tools\n\nThe MCP server provides the following tools:\n\n- `start_scan`: Start a new SpiderFoot scan\n- `get_scan_status`: Get the current status of a scan\n- `list_scans`: List all scans on the server\n- `stop_scan`: Stop a running scan\n- `delete_scan`: Delete a scan and its data\n- `get_scan_results`: Get results from a scan\n- `get_scan_summary`: Get a summary of scan results\n- `wait_for_scan_completion`: Wait for a scan to complete\n- `export_scan_results`: Export scan results in various formats\n- `get_available_modules`: Get list of available SpiderFoot modules\n- `search_scan_results`: Search across scan results\n- `get_scan_log`: Get log entries for a scan\n- `get_active_scans_summary`: Get summary of tracked scans\n- `ping`: Test connectivity to SpiderFoot server\n\n### MCP Client Configuration\n\nTo use this server with Claude Desktop or other MCP clients, add the following to your MCP configuration:\n\n```json\n{\n \"mcpServers\": {\n \"spiderfoot\": {\n \"command\": \"spiderfoot-mcp\",\n \"env\": {\n \"SPIDERFOOT_URL\": \"http://localhost:5001\",\n \"SPIDERFOOT_USERNAME\": \"admin\",\n \"SPIDERFOOT_PASSWORD\": \"your_password\"\n }\n }\n }\n}\n```\n\n## Requirements\n\n- Python 3.8+\n- spiderfoot-client>=1.0.0\n- fastmcp>=2.10.0\n- python-dotenv>=1.0.0\n- A running SpiderFoot instance\n\n## Dependencies\n\nThis package depends on the `spiderfoot-client` package, which provides the underlying SpiderFoot API client functionality.\n\n## License\n\nMIT License\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Model Context Protocol server for SpiderFoot OSINT automation",
"version": "1.0.0",
"project_urls": {
"Bug Tracker": "https://github.com/marlinkcyber/spiderfoot-mcp/issues",
"Documentation": "https://github.com/marlinkcyber/spiderfoot-mcp",
"Homepage": "https://github.com/marlinkcyber/spiderfoot-mcp",
"Repository": "https://github.com/marlinkcyber/spiderfoot-mcp"
},
"split_keywords": [
"spiderfoot",
" osint",
" security",
" mcp",
" model-context-protocol",
" reconnaissance"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "68a8a04602305f2c8a8d45685e73087053fd0bcf5ce7a6214cfb1a4357050b9f",
"md5": "4716652b07f838ed3d74aeaa6ae191fc",
"sha256": "b7e2e0aaf6cf27b9403f7419b36d4acf4fe06bdd98b6a5b1086c934ba2683477"
},
"downloads": -1,
"filename": "spiderfoot_mcp-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4716652b07f838ed3d74aeaa6ae191fc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 6843,
"upload_time": "2025-08-13T08:14:23",
"upload_time_iso_8601": "2025-08-13T08:14:23.692733Z",
"url": "https://files.pythonhosted.org/packages/68/a8/a04602305f2c8a8d45685e73087053fd0bcf5ce7a6214cfb1a4357050b9f/spiderfoot_mcp-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "dce0a98aede5d42eae4a97c4dedc3bc3cc90efd18599f8733785f3b0c74be4e0",
"md5": "d306d9b00bdea32abf2bacc7c8f36266",
"sha256": "ae1b7186f13d2a1100c051ff04cb2a00f9da383e2e484603e9cdf9e5bf62b186"
},
"downloads": -1,
"filename": "spiderfoot_mcp-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "d306d9b00bdea32abf2bacc7c8f36266",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 7387,
"upload_time": "2025-08-13T08:14:25",
"upload_time_iso_8601": "2025-08-13T08:14:25.330525Z",
"url": "https://files.pythonhosted.org/packages/dc/e0/a98aede5d42eae4a97c4dedc3bc3cc90efd18599f8733785f3b0c74be4e0/spiderfoot_mcp-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-13 08:14:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "marlinkcyber",
"github_project": "spiderfoot-mcp",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "spiderfoot-mcp"
}
JSON
