Open Websearch

🚀 Open-WebSearch MCP Server

このOpen-WebSearch MCP Serverは、複数エンジンの検索結果に基づくModel Context Protocol (MCP) サーバーです。APIキーを必要とせず、自由なウェブ検索をサポートします。

日本語 中文

✨ 主な機能

• 複数エンジンによるウェブ検索
  • bing
  • baidu
  • linux.do 一時的にサポートされていません
  • csdn
  • duckduckgo
  • exa
  • brave
• HTTPプロキシ設定：制限されたリソースにアクセスするための設定が可能です。
• APIキー不要：APIキーや認証を必要とせずに利用できます。
• 構造化された結果の返却：タイトル、URL、説明を含む構造化された結果を返します。
• 検索結果数の設定：一度の検索で取得する結果数を設定できます。
• デフォルト検索エンジンのカスタマイズ：使用するデフォルトの検索エンジンを設定できます。
• 個別記事内容の取得：csdnの記事内容を取得することができます。

📦 インストール

ローカルインストール

1. このリポジトリをクローンまたはダウンロードします。
2. 依存関係をインストールします。

npm install

3. サーバーをビルドします。

npm run build

4. サーバーをMCP設定に追加します。

Cherry Studio:

{
  "mcpServers": {
    "web-search": {
      "name": "Web Search MCP",
      "type": "streamableHttp",
      "description": "Multi-engine web search with article fetching",
      "isActive": true,
      "baseUrl": "http://localhost:3000/mcp"
    }
  }
}

VSCode (Claude Dev Extension):

{
  "mcpServers": {
    "web-search": {
      "transport": {
        "type": "streamableHttp",
        "url": "http://localhost:3000/mcp"
      }
    },
    "web-search-sse": {
      "transport": {
        "type": "sse",
        "url": "http://localhost:3000/sse"
      }
    }
  }
}

Claude Desktop:

{
  "mcpServers": {
    "web-search": {
      "transport": {
        "type": "streamableHttp",
        "url": "http://localhost:3000/mcp"
      }
    },
    "web-search-sse": {
      "transport": {
        "type": "sse",
        "url": "http://localhost:3000/sse"
      }
    }
  }
}

Dockerデプロイ

Docker Composeを使用して迅速にデプロイできます。

docker-compose up -d

または、直接Dockerを使用します。

docker run -d --name web-search -p 3000:3000 -e ENABLE_CORS=true -e CORS_ORIGIN=* ghcr.io/aas-ee/open-web-search:latest

環境変数の設定：

# CORSを有効にする (デフォルト: false)
ENABLE_CORS=true

# CORSオリジンの設定 (デフォルト: *)
CORS_ORIGIN=*

# デフォルト検索エンジン (オプション: bing, duckduckgo, exa, brave, デフォルト: bing)
DEFAULT_SEARCH_ENGINE=duckduckgo

# HTTPプロキシを有効にする (デフォルト: false)
USE_PROXY=true

# プロキシサーバーのURL (デフォルト: http://127.0.0.1:10809)
PROXY_URL=http://your-proxy-server:port

# サーバーのポート (デフォルト: 3000)
PORT=8080

その後、MCPクライアントで設定します。

{
  "mcpServers": {
    "web-search": {
      "name": "Web Search MCP",
      "type": "streamableHttp",
      "description": "Multi-engine web search with article fetching",
      "isActive": true,
      "baseUrl": "http://localhost:3000/mcp"
    },
    "web-search-sse": {
      "transport": {
        "name": "Web Search MCP",
        "type": "sse",
        "description": "Multi-engine web search with article fetching",
        "isActive": true,
        "url": "http://localhost:3000/sse"
      }
    }
  }
}

💻 使用例

サーバーは search、fetchLinuxDoArticle、fetchCsdnArticle の3つのツールを提供しています。

searchツールの使用方法

{
  "query": string,        // 検索クエリ
  "limit": number,        // オプション: 返却する結果数 (デフォルト: 10)
  "engines": string[]     // オプション: 使用するエンジン (bing,baidu,linuxdo,csdn,duckduckgo,exa,brave) デフォルトはbing
}

使用例：

use_mcp_tool({
  server_name: "web-search",
  tool_name: "search",
  arguments: {
    query: "search content",
    limit: 3,  // オプションパラメータ
    engines: ["bing", "csdn", "duckduckgo", "exa", "brave"] // オプションパラメータ、複数エンジンの組み合わせ検索をサポート
  }
})

レスポンス例：

[
  {
    "title": "Example Search Result",
    "url": "https://example.com",
    "description": "Description text of the search result...",
    "source": "Source",
    "engine": "Engine used"
  }
]

fetchCsdnArticleツールの使用方法

CSDNブログ記事の完全な内容を取得するために使用します。

{
  "url": string    // searchツールを使用して得られたCSDN検索結果のURL
}

使用例：

use_mcp_tool({
  server_name: "web-search",
  tool_name: "fetchCsdnArticle",
  arguments: {
    url: "https://blog.csdn.net/xxx/article/details/xxx"
  }
})

レスポンス例：

[
  {
    "content": "Example search result"
  }
]

fetchLinuxDoArticleツールの使用方法

Linux.doフォーラム記事の完全な内容を取得するために使用します。

{
  "url": string    // searchツールを使用して得られたlinuxdo検索結果のURL
}

使用例：

use_mcp_tool({
  server_name: "web-search",
  tool_name: "fetchLinuxDoArticle",
  arguments: {
    url: "https://xxxx.json"
  }
})

レスポンス例：

[
  {
    "content": "Example search result"
  }
]

📚 詳細ドキュメント

使用制限

このツールは複数エンジンの検索結果をスクレイピングして動作するため、以下の重要な制限事項に注意してください。

1. レート制限

   • 短時間に大量の検索を行うと、使用しているエンジンが一時的にリクエストをブロックする場合があります。
   • 推奨事項：
     • 適切な検索頻度を維持する
     • limitパラメータを適切に使用する
     • 必要に応じて検索間に遅延を追加する

2. 結果の精度

   • 対応するエンジンのHTML構造に依存するため、エンジンが更新されると失敗する場合があります。
   • 一部の結果には説明などのメタデータが欠けている場合があります。
   • 複雑な検索演算子は期待通りに動作しない場合があります。

3. 法的事項

   • このツールは個人利用のみを目的としています。
   • 対応するエンジンの利用規約に従ってください。
   • 実際の使用ケースに基づいて適切なレート制限を実装してください。

4. 検索エンジンの設定

   • デフォルト検索エンジンは DEFAULT_SEARCH_ENGINE 環境変数で設定できます。
   • サポートされているエンジン：bing, duckduckgo, exa, brave
   • 特定のウェブサイトを検索する際にはデフォルトエンジンが使用されます。

5. プロキシの設定

   • 特定の地域で特定の検索エンジンが利用できない場合、HTTPプロキシを設定できます。
   • 環境変数 USE_PROXY=true でプロキシを有効にします。
   • PROXY_URL でプロキシサーバーのアドレスを設定します。

コントリビューション

イシューの報告や機能改善の提案を歓迎します！

コントリビューターガイド

このリポジトリをフォークして独自のDockerイメージを公開する場合は、以下の設定を行う必要があります。

GitHubシークレットの設定

自動的なDockerイメージのビルドと公開を有効にするには、GitHubリポジトリの設定 (Settings → Secrets and variables → Actions) に以下のシークレットを追加してください。

必須シークレット:

• GITHUB_TOKEN: GitHubによって自動的に提供されます (設定不要)

オプションシークレット (Alibaba Cloud ACR用):

• ACR_REGISTRY: あなたのAlibaba Cloud Container RegistryのURL (例: registry.cn-hangzhou.aliyuncs.com)
• ACR_USERNAME: あなたのAlibaba Cloud ACRのユーザー名
• ACR_PASSWORD: あなたのAlibaba Cloud ACRのパスワード
• ACR_IMAGE_NAME: ACR内のイメージ名 (例: your-namespace/open-web-search)

CI/CDワークフロー

リポジトリにはGitHub Actionsのワークフロー (.github/workflows/docker.yml) が含まれており、自動的に以下のことを行います。

1. トリガー条件

   • mainブランチへのプッシュ
   • バージョンタグ (v*) のプッシュ
   • 手動でのワークフローのトリガー

2. ビルドとプッシュ先

   • GitHub Container Registry (ghcr.io) - 常に有効
   • Alibaba Cloud Container Registry - ACRシークレットが設定されている場合のみ有効

3. イメージタグ

   • ghcr.io/your-username/open-web-search:latest
   • your-acr-address/your-image-name:latest (ACRが設定されている場合)

フォークと公開の手順

1. このリポジトリをあなたのGitHubアカウントにフォークします。
2. シークレットを設定します (ACR公開が必要な場合)：
   • フォークしたリポジトリのSettings → Secrets and variables → Actionsに移動します。
   • 上記のACR関連のシークレットを追加します。
3. mainブランチに変更をプッシュするか、バージョンタグを作成します。
4. GitHub Actionsが自動的にDockerイメージをビルドしてプッシュします。
5. あなたのイメージを使用し、Dockerコマンドを更新します。

docker run -d --name web-search -p 3000:3000 -e ENABLE_CORS=true -e CORS_ORIGIN=* ghcr.io/your-username/open-web-search:latest

注意事項

• ACRシークレットを設定しない場合、ワークフローはGitHub Container Registryにのみ公開します。
• あなたのGitHubリポジトリでActionsが有効になっていることを確認してください。
• ワークフローはあなたのGitHubユーザー名 (小文字に変換) をGHCRイメージ名として使用します。

⭐ Star履歴

このプロジェクトが役に立った場合は、⭐ Starを付けていただけると励みになります！