Skip to main content
Glama
gkzhb
by gkzhb
README.md
# Crawl4AI Model Context Protocol Server

[![npm version](https://img.shields.io/npm/v/@gkzhb/crawl4ai-mcp)](https://www.npmjs.com/package/@gkzhb/crawl4ai-mcp)
[![GitHub stars](https://img.shields.io/github/stars/gkzhb/crawl4ai-mcp)](https://github.com/gkzhb/crawl4ai-mcp/stargazers)
[![GitHub issues](https://img.shields.io/github/issues/gkzhb/crawl4ai-mcp)](https://github.com/gkzhb/crawl4ai-mcp/issues)
[![GitHub license](https://img.shields.io/github/license/gkzhb/crawl4ai-mcp)](https://github.com/gkzhb/crawl4ai-mcp/blob/main/LICENSE)

This MCP Server helps you connect to your Crawl4AI docker API server.

Built with [gkzhb/fastmcp-template: TypeScript MCP Server Template](https://github.com/gkzhb/fastmcp-template).

## Quick Start

Prerequisites:

- Node.js 18+

To start Crawl4AI MCP server:

```bash
export CRAWL4AI_URL=http://your-server-ip:port
npx -y @gkzhb/crawl4ai-mcp
```

Notice that the command above is for Crawl4AI server v0.6.x.

For Crawl4AI server before v0.6.0, please use 0.0.x:

```bash
npx -y @gkzhb/crawl4ai-mcp@0.0.8
```

This MCP server uses Streamable HTTP. And the default Streamable HTTP URL is `http://localhost:8585/mcp`.
SSE is also supported and the SSE HTTP URL is `http://localhost:8585/sse`.

To customize MCP server, here are the shell environment variables:

|       Variable       | If Optional  | Description                                                     |
| :------------------: | :----------: | --------------------------------------------------------------- |
|    `CRAWL4AI_URL`    | **Required** | Crawl4AI docker API server URL, eg. `http://localhost:11545`    |
| `CRAWL4AI_API_TOKEN` |   Optional   | If Crawl4AI server enables authentication, you need to use this |
|    `SERVER_PORT`     |   Optional   | MCP server port, default value is `8585`                        |

This MCP also supports Browserless to crawl web page since v0.2.1

See [env.ts](./src/env.ts) for Browserless environment variables:
- `BROWSERLESS_URL`
- `BROWSERLESS_TOKEN`
- `BROWSERLESS_BLOCK_ADS`
- `BROWSERLESS_STEALTH_MODE`