Skip to content
FairCrawl Docs

MCP server

@faircrawl/mcp exposes FairCrawl as an MCP stdio server. The current tool set is:

  • faircrawl_scrape
  • faircrawl_crawl
  • faircrawl_map
  • faircrawl_research
  • faircrawl_agent
  • faircrawl_interact
  • faircrawl_enrich_company
  • faircrawl_freshness_check

Claude Code quick install

Terminal window
claude mcp add faircrawl \
  --env FAIRCRAWL_API_KEY=fc_live_xxx \
  -- npx -y @faircrawl/mcp

Generic MCP config

Use this shape in clients that manage MCP servers through JSON configuration.

{
  "mcpServers": {
    "faircrawl": {
      "command": "npx",
      "args": ["-y", "@faircrawl/mcp"],
      "env": {
        "FAIRCRAWL_API_KEY": "fc_live_xxx"
      }
    }
  }
}

Optional environment override

{
  "mcpServers": {
    "faircrawl": {
      "command": "npx",
      "args": ["-y", "@faircrawl/mcp"],
      "env": {
        "FAIRCRAWL_API_KEY": "fc_live_xxx",
        "FAIRCRAWL_API_BASE": "https://api.faircompany.ai/v1"
      }
    }
  }
}

Example prompts

Scrape https://stripe.com/pricing and summarize the pricing model.
Map https://docs.stripe.com and find checkout-related URLs.
Research browser automation vendors with web, reddit, and hackernews sources.
Interact with https://example.com/login and extract the dashboard once it appears.

Client notes

  • Claude Code can register the server directly from the CLI.
  • Cursor and Windsurf both work well with the generic stdio server config above.
  • The MCP server reads FAIRCRAWL_API_KEY at call time, so startup does not fail just because the env var is temporarily missing.