Quickstart Guide

MCP Integration (Recommended)
Direct API Access

The Model Context Protocol (MCP) provides seamless integration with AI applications like Claude Desktop, Cursor, and VS Code. This is the easiest way to use WebLinq tools.

Get your API key

Sign up for WebLinq - it’s free to start
Go to API Keys tab in your dashboard
Generate a new API key.

Copy your API key immediately - you won’t see it again after generation.

Configure your MCP client

WebLinq works with any MCP-compatible application. Choose your preferred client and add the configuration:

Claude Desktop

Edit your claude_desktop_config.json file:

{
  "mcpServers": {
    "weblinq": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote@latest",
        "https://mcp.weblinq.dev/mcp",
        "--header",
        "Authorization:Bearer your_api_key_here"
      ]
    }
  }
}

Cursor / VS Code

Add to your MCP settings in .cursor/mcp.json:

{
  "mcpServers": {
    "weblinq": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote@latest",
        "https://mcp.weblinq.dev/mcp",
        "--header",
        "Authorization:Bearer your_api_key_here"
      ]
    }
  }
}

LM Studio

Configure in LM Studio’s MCP settings (mcp.json):

{
  "mcpServers": {
    "weblinq": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote@latest",
        "https://mcp.weblinq.dev/mcp",
        "--header",
        "Authorization:Bearer your_api_key_here"
      ]
    }
  }
}

Perfect for: Research with local models, extracting documentation, analyzing websites.

BoltAI (macOS)

Import configuration or manually add to BoltAI settings:

{
  "mcpServers": {
    "weblinq": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote@latest",
        "https://mcp.weblinq.dev/mcp",
        "--header",
        "Authorization:Bearer your_api_key_here"
      ]
    }
  }
}

Perfect for: Quick web research, screenshot capture, content extraction across apps.

TypingMind

Enable WebLinq as a plugin in TypingMind settings:

{
  "mcpServers": {
    "weblinq": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote@latest",
        "https://mcp.weblinq.dev/mcp",
        "--header",
        "Authorization:Bearer your_api_key_here"
      ]
    }
  }
}

Perfect for: Content creation, market research, competitive analysis.

MCPOmni-Connect (CLI)

Connect via command line interface for automation:

npx mcpomni-connect \
  --server https://mcp.weblinq.dev/mcp \
  --header "Authorization:Bearer your_api_key_here" \
  --model openai/gpt-4

Perfect for: Automation scripts, batch processing, command-line workflows.

Postman (Testing)

Test WebLinq MCP tools directly in Postman for debugging:

POST https://mcp.weblinq.dev/mcp
Authorization: Bearer your_api_key_here
Content-Type: application/json

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "screenshot",
    "arguments": {
      "url": "https://example.com"
    }
  }
}

Perfect for: API testing, debugging tool calls, validating responses.

Replace your_api_key_here with your actual API key from the dashboard.

Start using WebLinq tools

Start using WebLinq tools naturally in conversation with your MCP client:

"Take a screenshot of https://stripe.com/pricing and extract the pricing table data. Then help me create a similar pricing page for my SaaS product."

"Analyze the design patterns on https://linear.app and generate HTML/CSS code to recreate their dashboard layout."

"Extract all the feature descriptions from https://notion.so and help me write compelling copy for my productivity app."

Available tools:

screenshot - Capture high-quality webpage screenshots
extract_markdown - Convert any webpage to clean markdown
ai_extract - Extract structured data using AI (pricing tables, features, etc.)
web_search - Search the internet for real-time information
scrape_elements - Extract specific elements using CSS selectors
generate_pdf - Create PDF documents from web pages
extract_links - Get all internal and external links
extract_youtube_captions - Get video transcripts and subtitles

MCP Troubleshooting

Authentication Issues

Common authentication problems and solutions:

Ensure the --header argument includes Authorization:Bearer your_api_key_here
Replace your_api_key_here with your actual API key
Check your configuration file syntax is valid JSON
Restart your MCP client after configuration changes

Transport Details

WebLinq uses the modern Streamable HTTP Transport: - Endpoint: https://mcp.weblinq.dev/mcp - Protocol: MCP version 2025-03-26 - Bridge Tool: mcp-remote handles the connection - Legacy Support: /sse endpoint available for compatibility

Common Issues

Troubleshooting tips:Tools not appearing: Check your config file syntax and restart your MCP clientAPI key errors: Test with curl -H "Authorization: Bearer YOUR_KEY" https://api.weblinq.dev/v1/web/markdownConnection timeouts: Check internet connection and firewall settings

Use WebLinq’s REST API directly for custom integrations and applications.

Get your API key

Sign up for WebLinq - it’s free to start
Go to API Keys tab in your dashboard
Generate a new API key.

Copy your API key immediately - you won’t see it again after creation.

Make your first request

Let’s extract content from a webpage using the markdown endpoint:

curl -X POST "https://api.weblinq.dev/v1/web/markdown" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com"}'

Replace YOUR_API_KEY with the actual API key from your dashboard.

Understanding the response

You’ll receive a JSON response with the extracted content:

{
  "success": true,
  "data": {
    "markdown": "# Example Domain\n\nThis domain is for use in illustrative examples...",
    "metadata": {
      "title": "Example Domain",
      "description": "This domain is for use in illustrative examples...",
      "url": "https://example.com",
      "timestamp": "2024-01-15T10:30:00Z",
      "wordCount": 42
    }
  },
  "creditsCost": 1
}

The data.markdown field contains the extracted content, while metadata provides additional page information.

Try other endpoints

Now explore these popular endpoints:

Take Screenshot

Capture page screenshots

Extract Data

AI extract data

Search Web

Search the internet

Generate PDF

Create PDF documents

General Tips

Rate limits

Check these headers in API responses:

X-RateLimit-Remaining: Requests left in current window
X-RateLimit-Reset: When the limit resets

Implement retry logic with exponential backoff for 429 responses.

Error handling

Always check the success field in responses:

if (!data.success) {
  console.error('API Error:', data.error.message);
  return;
}

// Process successful response
console.log(data.data);

Security

Store API keys in environment variables
Never commit keys to version control
Use different keys for development and production
Rotate keys regularly

What’s Next?

Explore All Tools

Browse complete API reference with all available endpoints

Learn MCP Protocol

Deep dive into Model Context Protocol fundamentals

Security Guide

Best practices for secure WebLinq integration

Use Case Examples

Real-world examples and implementation patterns

Need help?

Get Support

Email us for technical support and questions

MCP Community

Join the Model Context Protocol community

Introduction

Guides

MCP Troubleshooting

Take Screenshot

Extract Data

Search Web

Generate PDF

General Tips

What’s Next?

Explore All Tools

Learn MCP Protocol

Security Guide

Use Case Examples

Need help?

Get Support

MCP Community

Introduction

Guides

​MCP Troubleshooting

Take Screenshot

Extract Data

Search Web

Generate PDF

​General Tips

​What’s Next?

Explore All Tools

Learn MCP Protocol

Security Guide

Use Case Examples

​Need help?

Get Support

MCP Community

MCP Troubleshooting

General Tips

What’s Next?

Need help?