SearXNG Server

SearXNG MCP Server

An MCP server implementation that integrates the SearXNG API, providing web search capabilities.

Features

• Web Search: General queries, news, articles, with pagination.
• Pagination: Control which page of results to retrieve.
• Time Filtering: Filter results by time range (day, month, year).
• Language Selection: Filter results by preferred language.
• Safe Search: Control content filtering level for search results.

Tools

• searxng_web_search
  • Execute web searches with pagination
  • Inputs:
    • query (string): The search query. This string is passed to external search services.
    • pageno (number, optional): Search page number, starts at 1 (default 1)
    • time_range (string, optional): Filter results by time range - one of: "day", "month", "year" (default: none)
    • language (string, optional): Language code for results (e.g., "en", "fr", "de") or "all" (default: "all")
    • safesearch (number, optional): Safe search filter level (0: None, 1: Moderate, 2: Strict) (default: instance setting)
• web_url_read
  • Read and convert the content from a URL to markdown
  • Inputs:
    • url (string): The URL to fetch and process

Configuration

Setting the SEARXNG_URL

The SEARXNG_URL environment variable defines which SearxNG instance to connect to.

Environment Variable Format

Examples

Setup Instructions

1. Choose a SearxNG instance from the list of public instances or use your local environment
2. Set the SEARXNG_URL environment variable to the complete instance URL
3. If not specified, the default value http://localhost:8080 will be used

Using Authentication (Optional)

If you are using a password protected SearxNG instance you can set a username and password for HTTP Basic Auth:

• Set the AUTH_USERNAME environment variable to your username
• Set the AUTH_PASSWORD environment variable to your password

Note: Authentication is only required for password-protected SearxNG instances. See the usage examples below for how to configure authentication with different installation methods.

Proxy Support (Optional)

The server supports HTTP and HTTPS proxies through environment variables. This is useful when running behind corporate firewalls or when you need to route traffic through a specific proxy server.

Proxy Environment Variables

Set one or more of these environment variables to configure proxy support:

• HTTP_PROXY: Proxy URL for HTTP requests
• HTTPS_PROXY: Proxy URL for HTTPS requests
• http_proxy: Alternative lowercase version for HTTP requests
• https_proxy: Alternative lowercase version for HTTPS requests

Proxy URL Formats

The proxy URL can be in any of these formats:

Note: If no proxy environment variables are set, the server will make direct connections as normal. See the usage examples below for how to configure proxy settings with different installation methods.

NPX

Basic Configuration

With Authentication

With Proxy Support

With Authentication and Proxy Support

NPM

Basic Configuration

With Authentication

With Proxy Support

With Authentication and Proxy Support

Docker

Using Pre-built Image from Docker Hub

Basic Configuration

With Authentication

With Proxy Support

With Authentication and Proxy Support

Build Locally

Basic Configuration

With Authentication

With Proxy Support

With Authentication and Proxy Support

HTTP Transport (Optional)

The server supports both STDIO (default) and HTTP transports:

STDIO Transport (Default)

• Best for: Claude Desktop and most MCP clients
• Usage: Automatic - no additional configuration needed

HTTP Transport

• Best for: Web-based applications and remote MCP clients
• Usage: Set the MCP_HTTP_PORT environment variable

Basic HTTP Server Configuration

HTTP Server with Authentication

HTTP Server with Proxy Support

HTTP Server with Authentication and Proxy Support

HTTP Endpoints:

• MCP Protocol: POST/GET/DELETE /mcp
• Health Check: GET /health
• CORS: Enabled for web clients

Testing HTTP Server:

Running evals

The evals package loads an mcp client that then runs the src/index.ts file, so there is no need to rebuild between tests. You can see the full documentation here.

For Developers

Contributing to the Project

We welcome contributions! Here's how to get started:

0. Coding Guidelines

• Use TypeScript for type safety
• Follow existing error handling patterns
• Keep error messages concise but informative
• Write unit tests for new functionality
• Ensure all tests pass before submitting PRs
• Maintain test coverage above 90%
• Test changes with the MCP inspector
• Run evals before submitting PRs

1. Fork and Clone

2. Development Setup

3. Development Workflow

1. Create a feature branch:
   git checkout -b feature/your-feature-name
2. Make your changes in src/ directory
   • Main server logic: src/index.ts
   • Error handling: src/error-handler.ts
3. Build and test:
   npm run build # Build the project npm test # Run unit tests npm run test:coverage # Run tests with coverage report npm run inspector # Run MCP inspector
4. Run evals to ensure functionality:
   SEARXNG_URL=http://localhost:8080 OPENAI_API_KEY=your-key npx mcp-eval evals.ts src/index.ts

4. Submitting Changes

Testing

The project includes comprehensive unit tests with excellent coverage.

Running Tests

Test Statistics

• Unit tests covering all core modules
• 100% success rate with dynamic coverage reporting via c8
• HTML coverage reports generated in coverage/ directory

What's Tested

• Error handling (network, server, configuration errors)
• Type validation and schema guards
• Proxy configurations and environment variables
• Resource generation and logging functionality
• All module imports and function availability

License

This MCP server is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please see the LICENSE file in the project repository.