io.github.Crawleo/Crawleo-MCP

Install

Config snippet generator goes here (5 client tabs)

README

# Crawleo MCP Server

<a href="https://glama.ai/mcp/servers/@crawleo/crawleo-mcp">
  <img width="380" height="200" src="https://glama.ai/mcp/servers/@crawleo/crawleo-mcp/badge" alt="Crawleo MCP server" />
</a>


[![smithery badge](https://smithery.ai/badge/crawleo/crawleo)](https://smithery.ai/server/crawleo/crawleo)

Real-time web search and crawling capabilities for AI assistants through Model Context Protocol (MCP).

## Overview

Crawleo MCP enables AI assistants to access live web data through two powerful tools:
- **web.search** - Real-time web search with multiple output formats
- **web.crawl** - Deep content extraction from any URL

## Features

✅ **Real-time web search** from any country/language  
✅ **Multiple output formats** - Enhanced HTML, Raw HTML, Markdown, Plain Text  
✅ **Device-specific results** - Desktop, mobile, or tablet view  
✅ **Deep content extraction** with JavaScript rendering  
✅ **Zero data retention** - Complete privacy  
✅ **Auto-crawling** option for search results  

---

## Installation

### Option 1: NPM (Recommended for local usage)

Install globally via npm:

```bash
npm install -g crawleo-mcp
```

Or use npx without installing:

```bash
npx crawleo-mcp
```

### Option 2: Clone Repository

```bash
git clone https://github.com/Crawleo/Crawleo-MCP.git
cd Crawleo-MCP
npm install
npm run build
```

### Option 3: Docker

Build and run using Docker:

```bash
# Build the image
docker build -t crawleo-mcp .

# Run with your API key
docker run -e CRAWLEO_API_KEY=your_api_key crawleo-mcp
```

**Docker configuration for MCP clients:**

```json
{
  "mcpServers": {
    "crawleo": {
      "command": "docker",
      "args": ["run", "-i", "--rm", "-e", "CRAWLEO_API_KEY=YOUR_API_KEY_HERE", "crawleo-mcp"]
    }
  }
}
```

### Option 4: Remote Server (No installation needed)

Use the hosted version at `https://api.crawleo.dev/mcp` - see configuration examples below.

---

## Getting Your API Key

1. Visit [crawleo.dev](https://crawleo.dev)
2. Sign up for a free account
3. Navigate to your dashboard
4. Copy your API key (starts with `sk_`)

---

## Setup Instructions

### Using Local MCP Server (npm package)

After installing via npm, configure your MCP client to use the local server:

**Claude Desktop / Cursor / Windsurf (Local):**

```json
{
  "mcpServers": {
    "crawleo": {
      "command": "npx",
      "args": ["crawleo-mcp"],
      "env": {
        "CRAWLEO_API_KEY": "YOUR_API_KEY_HERE"
      }
    }
  }
}
```

**Or if installed globally:**

```json
{
  "mcpServers": {
    "crawleo": {
      "command": "crawleo-mcp",
      "env": {
        "CRAWLEO_API_KEY": "YOUR_API_KEY_HERE"
      }
    }
  }
}
```

**From cloned repository:**

```json
{
  "mcpServers": {
    "crawleo": {
      "command": "node",
      "args": ["/path/to/Crawleo-MCP/dist/index.js"],
      "env": {
        "CRAWLEO_API_KEY": "YOUR_API_KEY_HERE"
      }
    }
  }
}
```

---

### Using Remote Server (Hosted)

#### 1. Claude Desktop

**Location of config file:**

- **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
- **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
- **Linux**: `~/.config/Claude/claude_desktop_config.json`

**Configuration:**

```json
{
  "mcpServers": {
    "crawleo": {
      "url": "https://api.crawleo.dev/mcp",
      "transport": "http",
      "headers": {
        "Authorization": "Bearer YOUR_API_KEY_HERE"
      }
    }
  }
}
```

Replace `YOUR_API_KEY_HERE` with your actual API key from crawleo.dev.

**Steps:**
1. Open the config file in a text editor
2. Add the Crawleo MCP configuration
3. Save the file
4. Restart Claude Desktop completely (quit and reopen)
5. Start a new conversation and ask Claude to search the web!

**Example usage:**
```
"Search for the latest AI news and summarize the top 5 articles"
"Find Python web scraping tutorials and extract code examples"
```

---

### 2. Cursor IDE

**Location of config file:**

- **macOS**: `~/.cursor/config.json` or `~/Library/Application Support/Cursor/config.json`
- **Windows**: `%APPDATA%\Cursor\config.json`
- **Linux**: `~/.config/Cursor/config.json`

**Configuration:**

```json
{
  "mcpServers": {
    "crawleo": {
      "url": "https://api.crawleo.dev/mcp",
      "transport": "http",
      "headers": {
        "Authorization": "Bearer YOUR_API_KEY_HERE"
      }
    }
  }
}
```

**Steps:**
1. Locate and open your Cursor config file
2. Add the Crawleo MCP configuration
3. Save the file
4. Restart Cursor
5. The MCP tools will be available in your AI assistant

**Example usage in Cursor:**
```
"Search for React best practices and add them to my code comments"
"Find the latest documentation for this API endpoint"
```

---

### 3. Windsurf IDE

**Location of config file:**

- **macOS**: `~/Library/Application Support/Windsurf/config.json`
- **Windows**: `%APPDATA%\Windsurf\config.json`
- **Linux**: `~/.config/Windsurf/config.json`

**Configuration:**

```json
{
  "mcpServers": {
    "crawleo": {
      "url": "htt