tom/openapi-mcp-server
1
0
Fork 0
Code Issues Pull requests Packages 1 Activity Actions
openapi-mcp-server/docs/searxng.md
Tom Foster 719d4ecba4
All checks were successful
CI / Lint & Test (push) Successful in 23s
Details
CI / Build and push Docker image (push) Successful in 1m22s
Details
Update endpoint paths and lint codebase
2025-08-01 21:37:26 +01:00

2.6 KiB
Raw Permalink Blame History

SearXNG Tool

A search proxy tool that provides search functionality through SearXNG search instances with OpenAPI compatibility.

Overview

The SearXNG tool acts as a proxy server for SearXNG search instances, providing search capabilities within the OpenAPI MCP Server framework. It offers a standardised API interface for performing web searches across multiple search engines through SearXNG.

Endpoints

Method Endpoint Description
POST /searxng/search Search the web across multiple search engines. Accepts query, categories, engines, language, format, and pagination parameters. Returns structured search results with titles, URLs, content snippets, and metadata.
GET /searxng/categories Get available search categories (general, images, news, etc). Returns list of categories that can be used to filter search results.
GET /searxng/engines Get list of available search engines (Google, Bing, DuckDuckGo, etc). Returns engines that can be specified for targeted searches.

Key Features

  • Multi-Engine Search: Search across multiple search engines simultaneously
  • Category Filtering: Filter results by category (general, images, videos, news, etc.)
  • Engine Selection: Choose specific search engines for targeted results
  • Structured Results: Returns clean, structured search results with titles, URLs, and snippets
  • Metadata Rich: Includes search metadata like result count, suggestions, and engine info
  • Pagination Support: Navigate through multiple pages of search results
  • Language Support: Search in specific languages with language parameter

Configuration

Configure the target SearXNG instance using the SEARXNG_BASE_URL environment variable:

  • Default: http://localhost:8080
  • Custom: Set SEARXNG_BASE_URL=https://your-searxng-instance.com

Search Parameters

  • query: Search terms (required)
  • categories: Comma-separated category filters (optional)
  • engines: Comma-separated engine selection (optional)
  • language: Language code (default: "en")
  • format: Response format (default: "json")
  • pageno: Page number for pagination (default: 1)

Usage

The SearXNG tool is automatically loaded by the OpenAPI MCP Server framework. All endpoints are available under the /searxng prefix when the server is running. Visit /docs for interactive API documentation.

Dependencies

Requires a running SearXNG instance. SearXNG is a free, open-source metasearch engine that aggregates results from multiple search engines without tracking users.