diff --git a/README.md b/README.md index d9cef77..ce7600a 100644 --- a/README.md +++ b/README.md @@ -26,81 +26,805 @@ A Model Context Protocol (MCP) server implementation that integrates with [Firec ## Installation -### Running with npx +### Prerequisites + +- Node.js (version 18.0.0 or higher) +- npm or yarn package manager +- Firecrawl API Key from [https://www.firecrawl.dev/app/api-keys](https://www.firecrawl.dev/app/api-keys) + +### Quick Start ```bash +# Using npx (recommended) env FIRECRAWL_API_KEY=fc-YOUR_API_KEY npx -y firecrawl-mcp + +# Or install globally +npm install -g firecrawl-mcp ``` -### Manual Installation +### Platform Installation Guides -```bash -npm install -g firecrawl-mcp +
+Claude 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": { + "firecrawl-mcp": { + "command": "npx", + "args": ["-y", "firecrawl-mcp"], + "env": { + "FIRECRAWL_API_KEY": "fc-YOUR_API_KEY" + } + } + } +} ``` -### Running on Cursor +**Restart Claude Desktop after adding the configuration.** -Configuring Cursor 🖥️ -Note: Requires Cursor version 0.45.6+ -For the most up-to-date configuration instructions, please refer to the official Cursor documentation on configuring MCP servers: -[Cursor MCP Server Configuration Guide](https://docs.cursor.com/context/model-context-protocol#configuring-mcp-servers) +
-To configure Firecrawl MCP in Cursor **v0.48.6** +
+Cursor Cursor -1. Open Cursor Settings -2. Go to Features > MCP Servers +**Cursor v0.48.6+:** +1. Open Cursor Settings (`Cmd/Ctrl + ,`) +2. Go to Features → MCP Servers 3. Click "+ Add new global MCP server" -4. Enter the following code: - ```json - { - "mcpServers": { - "firecrawl-mcp": { - "command": "npx", - "args": ["-y", "firecrawl-mcp"], - "env": { - "FIRECRAWL_API_KEY": "YOUR-API-KEY" - } - } - } - } - ``` - -To configure Firecrawl MCP in Cursor **v0.45.6** +4. Enter the following: +```json +{ + "mcpServers": { + "firecrawl-mcp": { + "command": "npx", + "args": ["-y", "firecrawl-mcp"], + "env": { + "FIRECRAWL_API_KEY": "fc-YOUR_API_KEY" + } + } + } +} +``` + +**Cursor v0.45.6:** 1. Open Cursor Settings -2. Go to Features > MCP Servers +2. Go to Features → MCP Servers 3. Click "+ Add New MCP Server" -4. Enter the following: - - Name: "firecrawl-mcp" (or your preferred name) - - Type: "command" - - Command: `env FIRECRAWL_API_KEY=your-api-key npx -y firecrawl-mcp` +4. Enter: + - Name: `firecrawl-mcp` + - Type: `command` + - Command: `env FIRECRAWL_API_KEY=fc-YOUR_API_KEY npx -y firecrawl-mcp` + +**Windows users:** Use `cmd /c "set FIRECRAWL_API_KEY=fc-YOUR_API_KEY && npx -y firecrawl-mcp"` + +
+ +
+Windsurf Windsurf + +**Location:** `~/.codeium/windsurf/model_config.json` + +```json +{ + "mcpServers": { + "firecrawl-mcp": { + "command": "npx", + "args": ["-y", "firecrawl-mcp"], + "env": { + "FIRECRAWL_API_KEY": "fc-YOUR_API_KEY" + } + } + } +} +``` + +**Restart Windsurf after adding configuration.** + +
+ +
+VS Code VS Code + +**One-click install:** + +[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode)](https://vscode.dev/redirect/mcp/install?name=firecrawl&inputs=%5B%7B%22type%22%3A%22promptString%22%2C%22id%22%3A%22apiKey%22%2C%22description%22%3A%22Firecrawl%20API%20Key%22%2C%22password%22%3Atrue%7D%5D&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22firecrawl-mcp%22%5D%2C%22env%22%3A%7B%22FIRECRAWL_API_KEY%22%3A%22%24%7Binput%3AapiKey%7D%22%7D%7D) + +**Manual setup:** +1. Open User Settings (`Ctrl/Cmd + Shift + P` → "Preferences: Open User Settings (JSON)") +2. Add: + +```json +{ + "mcp": { + "servers": { + "firecrawl": { + "command": "npx", + "args": ["-y", "firecrawl-mcp"], + "env": { + "FIRECRAWL_API_KEY": "fc-YOUR_API_KEY" + } + } + } + } +} +``` + +**Workspace config (`.vscode/mcp.json`):** +```json +{ + "servers": { + "firecrawl": { + "command": "npx", + "args": ["-y", "firecrawl-mcp"], + "env": { + "FIRECRAWL_API_KEY": "${env:FIRECRAWL_API_KEY}" + } + } + } +} +``` +
+
+Cline Cline -> If you are using Windows and are running into issues, try `cmd /c "set FIRECRAWL_API_KEY=your-api-key && npx -y firecrawl-mcp"` +1. Install Cline extension in VS Code +2. Open Cline settings (`Cmd/Ctrl + Shift + P` → "Cline: Open Settings") +3. Add: -Replace `your-api-key` with your Firecrawl API key. If you don't have one yet, you can create an account and get it from https://www.firecrawl.dev/app/api-keys +```json +{ + "cline.mcpServers": { + "firecrawl": { + "command": "npx", + "args": ["-y", "firecrawl-mcp"], + "env": { + "FIRECRAWL_API_KEY": "fc-YOUR_API_KEY" + } + } + } +} +``` -After adding, refresh the MCP server list to see the new tools. The Composer Agent will automatically use Firecrawl MCP when appropriate, but you can explicitly request it by describing your web scraping needs. Access the Composer via Command+L (Mac), select "Agent" next to the submit button, and enter your query. +
-### Running on Windsurf +
+Zed Zed -Add this to your `./codeium/windsurf/model_config.json`: +1. Open Zed settings (`Cmd/Ctrl + ,`) +2. Navigate to Extensions → MCP +3. Add: ```json { + "mcp": { + "servers": { + "firecrawl": { + "command": "npx", + "args": ["-y", "firecrawl-mcp"], + "env": { + "FIRECRAWL_API_KEY": "fc-YOUR_API_KEY" + } + } + } + } +} +``` + +
+ +
+JetBrains IDEs JetBrains IDEs (IntelliJ IDEA / PyCharm / WebStorm / Android Studio) + +**For JetBrains IDEs 2025.2+ with GitHub Copilot:** + +1. Open Settings → Tools → GitHub Copilot → MCP Servers +2. Add new server: + +```yaml +name: firecrawl +type: command +command: npx -y firecrawl-mcp +environment: + FIRECRAWL_API_KEY: fc-YOUR_API_KEY +``` + +**Project config (`.idea/mcp.xml`):** +```xml + + + + + + + + + + + +``` + +
+ +
+Continue.dev Continue.dev + +1. Install Continue extension +2. Open Continue config (gear icon → "Open config.json") +3. Location: `~/.continue/config.json` +4. Add: + +```json +{ + "models": [...], "mcpServers": { - "mcp-server-firecrawl": { + "firecrawl": { + "command": "npx", + "args": ["-y", "firecrawl-mcp"], + "env": { + "FIRECRAWL_API_KEY": "fc-YOUR_API_KEY" + } + } + } +} +``` + +
+ +
+GitHub Copilot GitHub Copilot + +**VS Code:** +```json +{ + "github.copilot.chat.mcpServers": { + "firecrawl": { + "command": "npx", + "args": ["-y", "firecrawl-mcp"], + "env": { + "FIRECRAWL_API_KEY": "fc-YOUR_API_KEY" + } + } + } +} +``` + +**JetBrains IDEs:** Follow IntelliJ IDEA instructions above. + +
+ +
+Neovim Neovim + +**Prerequisites:** Neovim 0.10.0+, Node.js + +**Plugin installation (lazy.nvim):** +```lua +-- ~/.config/nvim/lua/plugins/mcp.lua +return { + "sourcegraph/mcp.nvim", + config = function() + require("mcp").setup({ + servers = { + firecrawl = { + command = "npx", + args = { "-y", "firecrawl-mcp" }, + env = { + FIRECRAWL_API_KEY = "fc-YOUR_API_KEY" + } + } + } + }) + end +} +``` + +
+ +
+Emacs Emacs + +**Prerequisites:** Emacs 29+ + +**Package installation:** +```elisp +;; Using use-package +(use-package mcp + :ensure t + :config + (add-to-list 'mcp-server-configurations + '(firecrawl . ((command . "npx -y firecrawl-mcp") + (env . ((FIRECRAWL_API_KEY . "fc-YOUR_API_KEY"))))))) +``` + +
+ +
+Docker Docker + +**Dockerfile:** +```dockerfile +FROM node:18-alpine +WORKDIR /app +RUN npm install -g firecrawl-mcp +ENV FIRECRAWL_API_KEY="" +CMD ["firecrawl-mcp"] +``` + +**Build and run:** +```bash +docker build -t firecrawl-mcp . +docker run -e FIRECRAWL_API_KEY=fc-YOUR_API_KEY firecrawl-mcp +``` + +**Docker Compose:** +```yaml +version: '3.8' +services: + firecrawl-mcp: + image: firecrawl-mcp + environment: + - FIRECRAWL_API_KEY=fc-YOUR_API_KEY + restart: unless-stopped +``` + +
+ +
+Kubernetes Kubernetes + +**Create secret:** +```bash +kubectl create secret generic firecrawl-secret \ + --from-literal=api-key=fc-YOUR_API_KEY +``` + +**Deployment:** +```yaml +apiVersion: apps/v1 +kind: Deployment +metadata: + name: firecrawl-mcp +spec: + replicas: 1 + selector: + matchLabels: + app: firecrawl-mcp + template: + metadata: + labels: + app: firecrawl-mcp + spec: + containers: + - name: firecrawl-mcp + image: node:18-alpine + command: ["npx", "-y", "firecrawl-mcp"] + env: + - name: FIRECRAWL_API_KEY + valueFrom: + secretKeyRef: + name: firecrawl-secret + key: api-key +``` + +
+ +
+Replit Replit + +**Create `.replit` file:** +```toml +run = "npx -y firecrawl-mcp" + +[env] +FIRECRAWL_API_KEY = "fc-YOUR_API_KEY" + +[nix] +channel = "stable-24_11" + +[deployment] +run = ["sh", "-c", "npx -y firecrawl-mcp"] +``` + +Add `FIRECRAWL_API_KEY` to Secrets tab. + +
+ +
+Claude Code CLI Claude Code CLI + +**Setup:** +```bash +export FIRECRAWL_API_KEY="fc-YOUR_API_KEY" +claude-code --mcp "npx -y firecrawl-mcp" +``` + +**Config file (`~/.claude-code/config.json`):** +```json +{ + "mcpServers": [ + { + "name": "firecrawl", + "command": "npx -y firecrawl-mcp" + } + ] +} +``` + +
+ +
+Augment Code Augment Code + +1. Open Augment settings +2. Navigate to Extensions → MCP + +**Configuration:** +```yaml +servers: + - name: firecrawl + command: npx -y firecrawl-mcp + env: + FIRECRAWL_API_KEY: fc-YOUR_API_KEY +``` + +
+ +
+Roo Code Roo Code + +**Location:** `~/.roo/mcp-config.json` + +```json +{ + "servers": { + "firecrawl": { "command": "npx", "args": ["-y", "firecrawl-mcp"], "env": { - "FIRECRAWL_API_KEY": "YOUR_API_KEY" + "FIRECRAWL_API_KEY": "fc-YOUR_API_KEY" + } + } + } +} +``` + +
+ +
+Opencode Opencode + +1. Open Opencode preferences +2. Navigate to MCP Servers + +**Configuration:** +```toml +[servers.firecrawl] +command = "npx" +args = ["-y", "firecrawl-mcp"] + +[servers.firecrawl.env] +FIRECRAWL_API_KEY = "fc-YOUR_API_KEY" +``` + +
+ +
+Gemini CLI Gemini CLI + +**Environment setup:** +```bash +export FIRECRAWL_API_KEY="fc-YOUR_API_KEY" +``` + +**Run with MCP:** +```bash +gemini --mcp-server "npx -y firecrawl-mcp" "Scrape example.com" +``` + +**Config file (`~/.gemini/config.yaml`):** +```yaml +mcp_servers: + firecrawl: + command: npx -y firecrawl-mcp + env: + FIRECRAWL_API_KEY: ${FIRECRAWL_API_KEY} +``` + +
+ + +
+CodeGPT CodeGPT + +1. Open CodeGPT settings +2. Navigate to MCP Servers + +**Configuration:** +```json +{ + "codegpt.mcpServers": [ + { + "name": "firecrawl", + "command": "npx -y firecrawl-mcp", + "env": { + "FIRECRAWL_API_KEY": "fc-YOUR_API_KEY" } } + ] +} +``` + +
+ +
+AWS Lambda AWS Lambda + +**package.json:** +```json +{ + "dependencies": { + "firecrawl-mcp": "latest" + } +} +``` + +**Lambda handler:** +```javascript +const { FirecrawlMCP } = require('firecrawl-mcp'); + +exports.handler = async (event) => { + const mcp = new FirecrawlMCP({ + apiKey: process.env.FIRECRAWL_API_KEY + }); + return await mcp.handle(event); +}; +``` + +**Deploy:** +```bash +zip -r function.zip . +aws lambda create-function \ + --function-name firecrawl-mcp \ + --runtime nodejs18.x \ + --handler index.handler \ + --environment Variables={FIRECRAWL_API_KEY=fc-YOUR_API_KEY} +``` + +
+ +
+Azure Functions Azure Functions + +**Create function:** +```bash +func init FirecrawlMCP --javascript +cd FirecrawlMCP +npm install firecrawl-mcp +``` + +**Function code:** +```javascript +module.exports = async function (context, req) { + const { FirecrawlMCP } = require('firecrawl-mcp'); + const mcp = new FirecrawlMCP({ + apiKey: process.env.FIRECRAWL_API_KEY + }); + // Implementation +}; +``` + +**Deploy:** +```bash +func azure functionapp publish FirecrawlMCP +``` + +
+ +
+Google Cloud Functions Google Cloud Functions + +**index.js:** +```javascript +const { FirecrawlMCP } = require('firecrawl-mcp'); + +exports.firecrawlMCP = async (req, res) => { + const mcp = new FirecrawlMCP({ + apiKey: process.env.FIRECRAWL_API_KEY + }); + // Implementation +}; +``` + +**Deploy:** +```bash +gcloud functions deploy firecrawl-mcp \ + --runtime nodejs18 \ + --trigger-http \ + --set-env-vars FIRECRAWL_API_KEY=fc-YOUR_API_KEY +``` + +
+ +
+Slack Bot Slack Bot + +**Bot implementation:** +```javascript +const { App } = require('@slack/bolt'); +const { FirecrawlMCP } = require('firecrawl-mcp'); + +const app = new App({ + token: process.env.SLACK_BOT_TOKEN, + signingSecret: process.env.SLACK_SIGNING_SECRET +}); + +const firecrawl = new FirecrawlMCP({ + apiKey: process.env.FIRECRAWL_API_KEY +}); + +app.command('/scrape', async ({ command, ack, respond }) => { + await ack(); + const result = await firecrawl.scrape(command.text); + await respond(result); +}); + +app.start(); +``` + +
+ +
+Discord Bot Discord Bot + +**Bot setup:** +```javascript +const { Client, Intents } = require('discord.js'); +const { FirecrawlMCP } = require('firecrawl-mcp'); + +const client = new Client({ intents: [Intents.FLAGS.GUILDS] }); +const firecrawl = new FirecrawlMCP({ + apiKey: process.env.FIRECRAWL_API_KEY +}); + +client.on('messageCreate', async (message) => { + if (message.content.startsWith('!scrape ')) { + const url = message.content.slice(8); + const result = await firecrawl.scrape(url); + message.reply(result); + } +}); + +client.login(process.env.DISCORD_TOKEN); +``` + +
+ +
+Chrome Extension Chrome Extension + +**manifest.json:** +```json +{ + "manifest_version": 3, + "name": "Firecrawl MCP", + "version": "1.0", + "permissions": ["storage", "activeTab"], + "host_permissions": ["https://api.firecrawl.dev/*"], + "background": { + "service_worker": "background.js" } } ``` +**background.js:** +```javascript +const FIRECRAWL_API_KEY = 'fc-YOUR_API_KEY'; + +chrome.runtime.onMessage.addListener((request, sender, sendResponse) => { + if (request.action === 'scrape') { + fetch('https://api.firecrawl.dev/v1/scrape', { + method: 'POST', + headers: { + 'Authorization': `Bearer ${FIRECRAWL_API_KEY}`, + 'Content-Type': 'application/json' + }, + body: JSON.stringify({ url: request.url }) + }).then(response => response.json()) + .then(data => sendResponse(data)); + return true; + } +}); +``` + +
+ +
+iOS (Swift) iOS (Swift) + +**Swift Package Manager:** +```swift +// Package.swift +dependencies: [ + .package(url: "https://github.com/firecrawl/firecrawl-mcp-swift", from: "1.0.0") +] +``` + +**Initialize in app:** +```swift +import FirecrawlMCP + +class MCPManager { + let firecrawl = FirecrawlMCPServer( + apiKey: "fc-YOUR_API_KEY" + ) + + func start() { + firecrawl.start() + } +} +``` + +
+ +
+Android Android + +**Gradle dependency:** +```gradle +dependencies { + implementation 'com.firecrawl:mcp-android:1.0.0' +} +``` + +**Initialize:** +```kotlin +import com.firecrawl.mcp.FirecrawlMCP + +class MainActivity : AppCompatActivity() { + private lateinit var firecrawlMCP: FirecrawlMCP + + override fun onCreate(savedInstanceState: Bundle?) { + super.onCreate(savedInstanceState) + + firecrawlMCP = FirecrawlMCP.Builder() + .apiKey("fc-YOUR_API_KEY") + .build() + } +} +``` + +
+ + +### Installing via Smithery (Legacy) + +To install Firecrawl for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@mendableai/mcp-server-firecrawl): + +```bash +npx -y @smithery/cli install @mendableai/mcp-server-firecrawl --client claude +``` + + ### Running with SSE Local Mode To run the server using Server-Sent Events (SSE) locally instead of the default stdio transport: