openwebui-tool-server

Python でサーバーを起動する

python main.py --port 8000 --host 0.0.0.0 --mode <openapi|mcp>

これにより、OpenAPI サーバーまたは MCP サーバーが http://0.0.0.0:8000 で起動します。

デフォルトの MCP モードは Streamable HTTP で、URL は http://0.0.0.0:8000/mcp です。

SSE モードの場合は --mcp-mode sse を追加します。URL は http://0.0.0.0:8000/sse です。

Docker でサーバーを起動する

docker run -p 8000:8000 \
    --name openwebui-tool-server \
   -e API_BEARER_TOKEN="your_token_here" \
   -e SEARXNG_BASE_URL="https://searxng.url" \
   oaklight/openwebui-tool-server:latest

または、docker compose を使用します：

docker compose up -d

API を確認する

サーバーが起動したら、以下の URL にアクセスしてください：

1. 対話型 API ドキュメント（Swagger UI） ブラウザーを開き、次の URL にアクセスします： http://127.0.0.1:8000/docs

2. 別の API ドキュメント（ReDoc） 次の URL で ReDoc ドキュメントを確認します： http://127.0.0.1:8000/redoc

MCP / OpenAPI モードの切り替え

このサーバーは、コマンドライン引数で設定できる複数のモードでの実行をサポートしています：

• OpenAPI モード（デフォルト）：

  command:
    ["python", "main.py", "--host=0.0.0.0", "--port=8000", "--mode=openapi"]
  

• MCP Streamable HTTP モード：

  command: ["python", "main.py", "--host=0.0.0.0", "--port=8000", "--mode=mcp"]
  

• MCP SSE モード：

  command:
    [
      "python",
      "main.py",
      "--host=0.0.0.0",
      "--port=8000",
      "--mode=mcp",
      "--mcp-mode=sse",
    ]
  

環境変数の設定

サーバーは、以下の環境変数で設定できます。

1. API_BEARER_TOKEN： このトークンは、API エンドポイントを保護するために使用されます。設定すると、Bearer Token の検証によって、保護されたすべてのルートで認証が有効になります。リクエストには、次の形式の Authorization ヘッダーを含める必要があります：Bearer <your_token>。

   動作：

   • 設定されている場合、verify_token がトークンの検証を強制します。
   • 未設定または空の場合、verify_token は認証なしですべてのリクエストを許可します（テストや、リクエストごとの認証ヘッダーを利用できない MCP モードで便利です）。

   設定に関する推奨事項：

   • API モード（openapi）：本番環境では、エンドポイントを保護するために API_BEARER_TOKEN を設定してください
   • MCP モード（mcp）：通常、認証なしで実行します（API_BEARER_TOKEN は未設定）

   Docker を使用した設定例：

   -e API_BEARER_TOKEN="my_secure_token"
   

2. SEARXNG_BASE_URL： プライバシーを尊重するメタ検索エンジン、SearXNG のベース URL です。/search_searxng の機能を有効にするには、この設定が必要です。

   動作：

   • 設定されている場合、WebSearchSearxng ツールはこの URL を使用して検索を実行します。
   • 未設定または空の場合、/search_searxng エンドポイントは無効になります（このエンドポイントへのリクエストはエラーになります）。ステータスコード 503 Service Unavailable が返され、SearXNG 検索機能が設定されていないこと、および SEARXNG_BASE_URL の設定を促す内容が明示されます。

   設定に関する推奨事項：

   • API モード（openapi）：SEARXNG_BASE_URL が適切に設定されていることを確認してください
   • MCP モード（mcp）：必要に応じて SearXNG を設定できます

   Docker を使用した設定例：

   -e SEARXNG_BASE_URL="https://searxng.instance.com"
   

サーバーモードに応じて、環境変数が設定されていることを確認してください。

• API モード（openapi）：エンドポイントを保護するため、本番環境では API_BEARER_TOKEN を設定し、SEARXNG_BASE_URL が適切に設定されていることを確認することを推奨します。
• MCP モード（mcp）：連携シナリオでは、認証なし（API_BEARER_TOKEN は未設定）で実行することが多く、必要に応じて SearXNG を設定できます。