Brave Search MCP Sse

🚀 Brave Search Proxy Server

This project aims to interact with Brave Search through a proxy server and support communication via Server-Sent Events (SSE). Here is detailed information about the project.

🚀 Quick Start

📦 Installation

Clone the repository

git clone git@github.com:yourusername/brave-search-mcp-server.git
cd brave-search-mcp-server

Install dependencies

Manage project dependencies using npm:

npm install

🏃‍♂️ Run the project

Start the service

node src/index.ts

Configure environment variables

Rename the .env.example file to .env and modify the configuration as needed.

✨ Features

This server offers the following features:

1. Docker-based containerized deployment: Provides full support for Docker image building through the Dockerfile.
2. Kubernetes deployment support: Offers Helm Chart files (helm/brave-search-mcp-sse) for easy deployment in a Kubernetes environment.
3. MCP protocol support: Implements the real-time message communication protocol (MCP) via SSE, allowing clients to interact with the server.

💻 Tool Functions

1. brave_web_search

• Description: Conducts a general web search using the Brave Search API.
• Input parameters:
  • query (string, required): The search query.
  • count (number, optional): The number of results to return (1 - 20, default is 10).
  • offset (number, optional): The pagination offset (0 - 9, default is 0).
  • Other Brave API parameters such as search_lang, country, freshness, result_filter, safesearch may be supported (see src/services/braveSearchApi.ts for specific parameters).
• Output: Streams MCP messages containing search results (title, link, paragraph, etc.).

2. brave_local_search

• Description: Performs a local business and location search using the Brave Search API. Falls back to a web search if there are no local results.
• Input parameters:
  • query (string, required): The local search query (e.g., "pizza near me", "cafes in downtown").
  • count (number, optional): The number of results to return (default is 10).
• Output: Streams MCP messages containing local business information.

📁 Project Structure

Here is the project's directory structure:

brave-search-mcp-server/
  ├── Dockerfile                  # Docker image build file
  ├── package.json               # Project dependency management file
  ├── src/
  │   ├── index.ts                # Project main entry file
  │   └── services/
  │       └── braveSearchApi.ts  # Brave Search API call handling logic
  ├── .env.example               # Example environment variable configuration file
  └── README.md                   # Project documentation

💻 Usage Examples

Client call example

const fetch = require('node-fetch');

async function search(query) {
  const response = await fetch('http://localhost:3000', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      "command": "brave_web_search",
      "params": {
        "query": query
      }
    })
  });
  
  const decoder = new TextDecoder();
  const encoder = new TextEncoder();
  
  for await (const chunk of response.body.get chunks()) {
    console.log(decoder.decode(chunk));
  }
}

🤝 Contribution Guidelines

Submit code

1. Create a feature branch

   git checkout -b feature/your-feature-name
   

2. Commit changes

   git add .
   git commit -m 'feat: Add a new feature'
   

3. Push to the remote repository and create a Pull Request

   git push origin feature/your-feature-name
   

Contribution criteria

• Please follow the project's code style and specifications.
• The submitted code must include corresponding test cases.
• Please ensure that the commit messages are clear and concise.

📄 License

This project is licensed under the MIT License. The specific terms are as follows:

MIT License

Copyright (c) [Year] [Author's Name]

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

For more detailed information, please refer to MIT License.