Brave Search SSE

🚀 Brave Search MCP Service with SSE Support

This is a Model Context Protocol (MCP) server that provides Brave Search functionality and integrates Server-Sent Events (SSE). It can be deployed to Coolify and used as a real-time search service.

🚀 Quick Start

This MCP server offers Brave Search capabilities with SSE integration. It can be easily deployed on Coolify for real - time search services.

✨ Features

• Integrates the MCP protocol with the Brave Search API.
• Delivers real - time search results via SSE.
• Supports deployment on Docker and Coolify.
• Implemented in TypeScript.
• Provides an Express.js SSE endpoint.

📦 Installation

Prerequisites

• A Brave Search API key.
• Node.js version 18 or higher.
• Docker (for containerized deployment).
• A Coolify instance.

Local Development

1. Clone the repository.
2. Create a .env file and add your Brave API key:

   BRAVE_API_KEY=your_api_key_here
   PORT=3001
   

3. Install the dependencies:

   npm install
   

4. Start the development server:

   npm run dev
   

Docker Deployment

1. Build and run using docker - compose:

   docker-compose up --build
   

Coolify Deployment

1. In your Coolify console, create a new service.
2. Select "Deploy from source".
3. Configure as follows:
   • Repository URL: Your repository URL.
   • Branch: main.
   • Build command: npm run build.
   • Start command: npm start.
   • Port: 3001.
   • Environment variables:
     • BRAVE_API_KEY=your_api_key_here
     • PORT=3001

💻 Usage Examples

Using SSE Integration

SSE Endpoint

GET http://your_server:3001/sse

Provide real - time search results through the SSE endpoint. Connect using the EventSource API:

const eventSource = new EventSource('http://your_server:3001/sse');

eventSource.onmessage = (event) => {
  const data = JSON.parse(event.data);
  // Process search results
  console.log(data);
};

eventSource.onerror = (error) => {
  console.error('SSE error:', error);
  eventSource.close();
};

Message Endpoint

POST http://your_server:3001/messages
Content-Type: application/json

{
  "query": "your_search_query",
  "count": 10  // Optional, default: 10, maximum: 20
}

Use this endpoint to trigger a search, and the results will be broadcast to all connected SSE clients.

MCP Usage

The server provides the following MCP tools:

• brave_web_search: Perform a web search via the Brave Search API

  {
    query: string;    // Search query
    count?: number;   // Number of results (1 - 20, default: 10)
  }
  

🔧 Technical Details

Error Handling

• The server broadcasts errors to all connected SSE clients.
• The error format is as follows:

  {
    "type": "error",
    "error": "error_message"
  }
  

📚 Documentation

Notes

• SSE connections remain open until the client closes them.
• Each search result is broadcast to all connected clients.
• The server automatically handles disconnections and cleanup.
• In a production environment, it is recommended to implement authentication for the message endpoint.