Cloudflare Browser Rendering MCP

🚀 Cloudflare Browser Rendering Model Context Protocol (MCP) Server

This server is designed to leverage Cloudflare's browser rendering technology to generate web page snapshots, process network content, and integrate with large language models.

🚀 Quick Start

Installation

1. Clone the repository.
2. Build the project using npm:

   npm install
   npm run build
   

3. Start the tests:

   npm test
   

Usage

Install Dependencies

npm install cloudflare-mcp

Start the MCP Service

node src/server.ts

✨ Features

Core Features

1. Browser Rendering

   • Generate web page snapshots using Cloudflare's browser rendering technology.
   • Support multiple output formats (e.g., images, HTML).

2. Content Processing

   • Provide various network content processing tools, including:
     • Text extraction
     • Structured data extraction
     • Content summarization

3. Model Adaptation

   • Integrate with mainstream large language models (e.g., GPT).
   • Support custom model extensions.

📦 Installation Guide

1. Clone the repository.
2. Use npm to build the project:

   npm install
   npm run build
   

3. Start the tests:

   npm test
   

💻 Usage Examples

Basic Usage

Configuration Example

Configure Cloudflare account information in src/server.ts:

import { CloudflareMCP } from 'cloudflare-mcp'

const cf = new CloudflareMCP({
  email: 'your@email.com',
  apiKey: 'your_api_key',
  zoneId: 'your_zone_id'
})

Request Examples

Get a Web Page Snapshot

await cf.renderPage('https://example.com', {
  width: 1280,
  height: 800,
  format: 'png'
})

Extract Text Content

const text = await cf.extractText('https://example.com')
console.log(text)

📚 Documentation

Project Structure

Troubleshooting

Common Issues

1. "BROWSER_RENDERING_API environment variable is not set"

   • Check the environment variable configuration in src/server.ts.
   • Ensure that the Cloudflare account information is correctly filled in.

2. "Rendering service is unavailable"

   • Check the Cloudflare console to confirm that the browser rendering function is enabled.
   • Ensure that the API request frequency is within the allowed range.

3. "Insufficient permissions"

   • Check if the account has the required permissions.
   • Contact the Cloudflare support team to upgrade permissions.

Development Guide

Code Contribution Guidelines

1. Follow the Cloud Development Guidelines.
2. Run unit tests using npm test before submitting a PR.
3. Ensure that the documentation is updated synchronously.

List of Contributors

• Zhang San (Project Lead)
• Li Si (Developer)
• Wang Wu (Test Engineer)

📄 License

MIT