Brave Search MCP Sse

🚀 勇敢搜索代理服務器

本項目是勇敢搜索 MCP 代理服務器，藉助代理服務器實現與 Brave Search 的交互，還支持通過即時流協議（Server-Sent Events, SSE）進行通信，為用戶提供便捷的搜索服務。

🚀 快速開始

安裝指南

克隆倉庫

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

安裝依賴

使用 npm 管理項目依賴：

npm install

項目運行

啟動服務

node src/index.ts

配置環境變量

將 .env.example 文件重命名為 .env，並根據需要修改配置。

✨ 主要特性

• 基於 Docker 的容器化部署：通過 Dockerfile 提供完整的 Docker 鏡像構建支持。
• Kubernetes 部署支持：提供 Helm Chart 文件 (helm/brave-search-mcp-sse)，方便在 Kubernetes 環境中進行部署。
• MCP 協議支持：通過 SSE 實現即時消息通信協議 (MCP)，允許客戶端與服務器進行交互。

📦 工具功能

1. brave_web_search

• 描述：使用 Brave Search API 進行通用網絡搜索。
• 輸入參數：
  • query（字符串，必需）：搜索查詢。
  • count（數字，可選）：返回結果的數量 (1 - 20，默認為 10)。
  • offset（數字，可選）：分頁偏移量 (0 - 9，默認為 0)。
  • 其他 Brave API 參數如 search_lang、country、freshness、result_filter、safesearch 可能被支持（具體參數請參見 src/services/braveSearchApi.ts）。
• 輸出：流式傳輸 MCP 消息，包含搜索結果（標題、鏈接、段落等）。

2. brave_local_search

• 描述：使用 Brave Search API 進行本地商業和地點搜索。如果沒有本地結果，則回退到網絡搜索。
• 輸入參數：
  • query（字符串，必需）：本地搜索查詢（例如 "pizza near me"、"downtown 的咖啡館"）。
  • count（數字，可選）：返回結果的數量 (默認為 10)。
• 輸出：流式傳輸 MCP 消息，包含本地商家信息。

💻 使用示例

基礎用法

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));
  }
}

🤝 貢獻指南

提交代碼

1. 創建功能分支

git checkout -b feature/your-feature-name

2. 提交更改

git add .
git commit -m 'feat: 添加新功能'

3. 推送到遠程倉庫並創建 Pull Request

git push origin feature/your-feature-name

貢獻準則

• 請遵循項目代碼風格和規範。
• 提交的代碼必須包含相應的測試用例。
• 請確保提交的信息清晰明瞭。

📄 許可證

本項目使用 MIT 許可證，具體條款如下：

MIT License

Copyright (c) [年份] [作者姓名]

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.

更多詳細信息請參考 MIT License。