web-search-searxng-mcp 0.1.0__tar.gz

web_search_searxng_mcp-0.1.0/.github/workflows/publish-to-pypi.yml

@@ -0,0 +1,38 @@
+---
+name: Publish to PyPI
+
+'on':
+  release:
+    types: [published]
+  workflow_dispatch:  # Allow manual trigger for testing
+
+jobs:
+  build-and-publish:
+    name: Build and publish Python distribution to PyPI
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write  # Required for trusted publishing
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install UV
+        uses: astral-sh/setup-uv@v4
+        with:
+          enable-cache: true
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          # Uses OIDC trusted publishing - no manual token needed
+          # Configure at: https://pypi.org/manage/account/publishing/
+          skip-existing: true

web_search_searxng_mcp-0.1.0/.gitignore

@@ -0,0 +1,224 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+
+# Sensitive Information & Environment
+.env
+.env.local
+.env.*
+!.env.example
+!.env.template
+secrets.yml
+*.key
+*.pem
+*.cert
+*.crt
+
+# Project specific sensitive files
+# searxng/settings.yml can contain secret keys
+searxng/settings.yml

web_search_searxng_mcp-0.1.0/.python-version

@@ -0,0 +1 @@
+3.13

web_search_searxng_mcp-0.1.0/CHANGELOG.md

@@ -0,0 +1,28 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+- None yet
+
+### Changed
+- None yet
+
+### Fixed
+- None yet
+
+## [0.1.0] - 2026-02-05
+
+### Added
+- Initial project release with web search capabilities
+- MCP server implementation
+- SearXNG integration
+- Documentation and configuration setup
+
+[Unreleased]: https://github.com/ViktoriaKutseva/web-search-mcp/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/ViktoriaKutseva/web-search-mcp/releases/tag/v0.1.0

web_search_searxng_mcp-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ViktoriaKutseva
+
+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.

web_search_searxng_mcp-0.1.0/PKG-INFO

@@ -0,0 +1,127 @@
+Metadata-Version: 2.4
+Name: web-search-searxng-mcp
+Version: 0.1.0
+Summary: Add your description here
+License-File: LICENSE
+Requires-Python: >=3.13
+Requires-Dist: fastmcp>=2.14.5
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: loguru>=0.7.3
+Requires-Dist: pydantic-settings>=2.12.0
+Requires-Dist: pydantic>=2.12.5
+Description-Content-Type: text/markdown
+
+# Step-by-Step Setup Guide for Web Search MCP
+
+This guide lists the specific steps to set up the Web Search MCP server and integrate it into your development environment or MCP clients (like Claude Desktop).
+
+## Prerequisites
+
+Before starting, ensure you have the following installed:
+
+1.  **Docker & Docker Compose**: For running the local SearxNG instance.
+2.  **uv**: An extremely fast Python package installer and resolver.
+    - Install instructions: [astral.sh/uv](https://github.com/astral-sh/uv)
+
+## Step 1: Installation & Setup
+
+1.  **Clone the Repository**
+    Clone this repository to a permanent location on your machine.
+    ```bash
+    git clone https://github.com/ViktoriaKutseva/web-search-mcp.git
+    cd web-search-mcp
+    ```
+
+2.  **Initialize Environment**
+    Use `uv` to sync dependencies (this creates the virtual environment).
+    ```bash
+    uv sync
+    ```
+
+## Step 2: Start the Search Engine
+
+The MCP server relies on a local instance of SearxNG.
+
+1.  **Configure SearxNG**
+    Copy the example settings file to create the actual configuration.
+    ```bash
+    cp searxng/settings.yml.example searxng/settings.yml
+    ```
+    *Note: The `settings.yml` file is git-ignored. You should generate a new `secret_key` inside it.*
+
+2.  **Start Services**
+    From the repository root run:
+    ```bash
+    docker compose up -d
+    ```
+
+3.  **Verify SearxNG**
+    Open your browser and navigate to `http://localhost:8080`. You should see the SearxNG search interface.
+
+## Step 3: Configure MCP Client
+
+To use this tool in other specific projects or global editors, you need to register it with your MCP Client (e.g., Claude Desktop, VS Code extension).
+
+### Option A: Integration with Claude Desktop
+
+1.  **Get Absolute Path**
+    Run `pwd` (Linux/macOS) or `cd` (Windows) in the repository root to get the full path.
+    *Example:* `/home/user/code/web-search-mcp`
+
+2.  **Locate Config File**
+    Find or create the `claude_desktop_config.json` file:
+    *   **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
+    *   **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
+
+3.  **Edit Configuration**
+    Add the `web-search` entry to the `mcpServers` object. Replace `/ABSOLUTE/PATH/TO/` with your actual path.
+
+    ```json
+    {
+      "mcpServers": {
+        "web-search": {
+          "command": "uv",
+          "args": [
+            "--directory",
+            "/ABSOLUTE/PATH/TO/web-search-mcp",
+            "run",
+            "web-search-mcp"
+          ],
+          "env": {
+            "SEARXNG_BASE_URL": "http://localhost:8080"
+          }
+        }
+      }
+    }
+    ```
+
+4.  **Restart Claude Desktop**
+    Completely quit and restart the application for changes to take effect.
+
+## Step 4: Verification
+
+1.  Open your MCP Client (e.g., Claude Desktop).
+2.  Look for the 🔌 icon or installed tools list to verify `web-search` is connected.
+3.  Ask a question that requires searching the web:
+    > "Search for the latest release of Python and tell me the date."
+
+## Troubleshooting
+
+-   **SearxNG not reachable**: Ensure Docker container is running (`docker ps`) and port 8080 is free.
+-   **MCP Error**: Check the logs in your client or run `uv run web-search-mcp` manually in the terminal to see if it starts without crashing (it will wait for stdio input).
+
+## Configuration
+
+Settings are managed via environment variables (or \`.env\` file):
+
+- \`SEARXNG_BASE_URL\`: URL of the SearxNG instance (default: \`http://localhost:8080\`)
+- \`SEARXNG_TIMEOUT\`: Request timeout in seconds (default: \`10\`)
+- \`LOG_LEVEL\`: Logging level (default: \`INFO\`)
+
+## Development
+
+- **Architecture**: Follows simplified DDD guidelines.
+  - \`domains/\`: Business logic
+  - \`infrastructure/\`: External implementations (SearxNG client)
+  - \`entry_points/\`: MCP server and Main execution
+  - \`config/\`: Settings

web_search_searxng_mcp-0.1.0/README.md

@@ -0,0 +1,114 @@
+# Step-by-Step Setup Guide for Web Search MCP
+
+This guide lists the specific steps to set up the Web Search MCP server and integrate it into your development environment or MCP clients (like Claude Desktop).
+
+## Prerequisites
+
+Before starting, ensure you have the following installed:
+
+1.  **Docker & Docker Compose**: For running the local SearxNG instance.
+2.  **uv**: An extremely fast Python package installer and resolver.
+    - Install instructions: [astral.sh/uv](https://github.com/astral-sh/uv)
+
+## Step 1: Installation & Setup
+
+1.  **Clone the Repository**
+    Clone this repository to a permanent location on your machine.
+    ```bash
+    git clone https://github.com/ViktoriaKutseva/web-search-mcp.git
+    cd web-search-mcp
+    ```
+
+2.  **Initialize Environment**
+    Use `uv` to sync dependencies (this creates the virtual environment).
+    ```bash
+    uv sync
+    ```
+
+## Step 2: Start the Search Engine
+
+The MCP server relies on a local instance of SearxNG.
+
+1.  **Configure SearxNG**
+    Copy the example settings file to create the actual configuration.
+    ```bash
+    cp searxng/settings.yml.example searxng/settings.yml
+    ```
+    *Note: The `settings.yml` file is git-ignored. You should generate a new `secret_key` inside it.*
+
+2.  **Start Services**
+    From the repository root run:
+    ```bash
+    docker compose up -d
+    ```
+
+3.  **Verify SearxNG**
+    Open your browser and navigate to `http://localhost:8080`. You should see the SearxNG search interface.
+
+## Step 3: Configure MCP Client
+
+To use this tool in other specific projects or global editors, you need to register it with your MCP Client (e.g., Claude Desktop, VS Code extension).
+
+### Option A: Integration with Claude Desktop
+
+1.  **Get Absolute Path**
+    Run `pwd` (Linux/macOS) or `cd` (Windows) in the repository root to get the full path.
+    *Example:* `/home/user/code/web-search-mcp`
+
+2.  **Locate Config File**
+    Find or create the `claude_desktop_config.json` file:
+    *   **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
+    *   **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
+
+3.  **Edit Configuration**
+    Add the `web-search` entry to the `mcpServers` object. Replace `/ABSOLUTE/PATH/TO/` with your actual path.
+
+    ```json
+    {
+      "mcpServers": {
+        "web-search": {
+          "command": "uv",
+          "args": [
+            "--directory",
+            "/ABSOLUTE/PATH/TO/web-search-mcp",
+            "run",
+            "web-search-mcp"
+          ],
+          "env": {
+            "SEARXNG_BASE_URL": "http://localhost:8080"
+          }
+        }
+      }
+    }
+    ```
+
+4.  **Restart Claude Desktop**
+    Completely quit and restart the application for changes to take effect.
+
+## Step 4: Verification
+
+1.  Open your MCP Client (e.g., Claude Desktop).
+2.  Look for the 🔌 icon or installed tools list to verify `web-search` is connected.
+3.  Ask a question that requires searching the web:
+    > "Search for the latest release of Python and tell me the date."
+
+## Troubleshooting
+
+-   **SearxNG not reachable**: Ensure Docker container is running (`docker ps`) and port 8080 is free.
+-   **MCP Error**: Check the logs in your client or run `uv run web-search-mcp` manually in the terminal to see if it starts without crashing (it will wait for stdio input).
+
+## Configuration
+
+Settings are managed via environment variables (or \`.env\` file):
+
+- \`SEARXNG_BASE_URL\`: URL of the SearxNG instance (default: \`http://localhost:8080\`)
+- \`SEARXNG_TIMEOUT\`: Request timeout in seconds (default: \`10\`)
+- \`LOG_LEVEL\`: Logging level (default: \`INFO\`)
+
+## Development
+
+- **Architecture**: Follows simplified DDD guidelines.
+  - \`domains/\`: Business logic
+  - \`infrastructure/\`: External implementations (SearxNG client)
+  - \`entry_points/\`: MCP server and Main execution
+  - \`config/\`: Settings

web_search_searxng_mcp-0.1.0/docker-compose.yml

@@ -0,0 +1,25 @@
+version: '3.7'
+
+services:
+  searxng:
+    image: searxng/searxng:latest
+    container_name: searxng
+    volumes:
+      - ./searxng:/etc/searxng:rw
+    ports:
+      - "8080:8080"
+    environment:
+      - SEARXNG_BASE_URL=http://localhost:8080/
+      - UWSGI_WORKERS=4
+      - UWSGI_THREADS=4
+    cap_drop:
+      - ALL
+    cap_add:
+      - CHOWN
+      - SETGID
+      - SETUID
+    logging:
+      driver: "json-file"
+      options:
+        max-size: "1m"
+        max-file: "1"

web_search_searxng_mcp-0.1.0/docs/PUBLISHING.md

@@ -0,0 +1,118 @@
+# Publishing to PyPI
+
+This project uses [UV](https://docs.astral.sh/uv/) as the package manager and GitHub Actions for automated publishing to PyPI.
+
+## Prerequisites
+
+1. **PyPI Account**: Create an account at [https://pypi.org/](https://pypi.org/)
+2. **Trusted Publishing**: Configure trusted publishing (no API tokens needed!) at [https://pypi.org/manage/account/publishing/](https://pypi.org/manage/account/publishing/)
+   - Add a new publisher with:
+     - PyPI Project Name: `web-search-searxng-mcp`
+     - Owner: `ViktoriaKutseva`
+     - Repository name: `web-search-mcp`
+     - Workflow name: `publish-to-pypi.yml`
+     - Environment name: (leave blank)
+
+## Automated Publishing (Recommended)
+
+The project is configured to automatically publish to PyPI when a new GitHub release is created:
+
+1. **Update version** in `pyproject.toml`:
+   ```toml
+   version = "0.2.0"  # Update to your new version
+   ```
+
+2. **Update version** in `src/web_search_mcp/settings.py`:
+   ```python
+   app_version: str = Field(default="0.2.0", description="Application version")
+  # Update to your new version
+   ```
+
+1. **Update CHANGELOG.md** with the new version changes and link for release.
+
+2. **Commit and push** your changes:
+   ```bash
+   git add pyproject.toml
+   git commit -m "Bump version to 0.2.0"
+   git push
+   ```
+
+3. **Create a GitHub release**:
+   
+   Using GitHub CLI (recommended):
+   ```bash
+   gh release create v0.2.0 \
+     --title "v0.2.0 - Release Title" \
+     --notes "Release notes here..."
+   ```
+   
+   Or using GitHub web interface:
+   - Go to [https://github.com/ViktoriaKutseva/web-search-mcp/releases/new](https://github.com/ViktoriaKutseva/web-search-mcp/releases/new)
+   - Create a new tag (e.g., `v0.2.0`)
+   - Add release title and description
+   - Click "Publish release"
+   
+   To verify the release:
+   ```bash
+   gh release view v0.2.0
+   ```
+
+4. **GitHub Actions will automatically**:
+   - Build the package using UV
+   - Publish to PyPI using trusted publishing
+   - You can monitor the progress in the Actions tab
+
+## Manual Publishing
+
+If you need to publish manually:
+
+1. **Install UV** (if not already installed):
+   ```bash
+   pip install uv
+   ```
+
+2. **Build the package**:
+   ```bash
+   uv build
+   ```
+   This creates distribution files in the `dist/` directory.
+
+3. **Publish using UV** (requires PyPI API token):
+   ```bash
+   uv publish
+   ```
+   Or use `twine`:
+   ```bash
+   pip install twine
+   twine upload dist/*
+   ```
+
+## Testing on TestPyPI
+
+Before publishing to the main PyPI, you can test on TestPyPI:
+
+1. Configure trusted publishing for TestPyPI at [https://test.pypi.org/manage/account/publishing/](https://test.pypi.org/manage/account/publishing/)
+
+2. Manually trigger the workflow or modify the workflow to publish to TestPyPI:
+   ```bash
+   uv publish --index-url https://test.pypi.org/legacy/
+   ```
+
+3. Test installation:
+   ```bash
+   pip install --index-url https://test.pypi.org/simple/ web-search-mcp
+   ```
+
+## Best Practices
+
+1. **Always create tags on `main` branch** - Never tag on `develop` or feature branches
+2. **Merge develop to main before tagging** - Ensure all changes are in main
+3. **Test on TestPyPI first** (optional but recommended for major releases)
+4. **Use semantic versioning** (MAJOR.MINOR.PATCH)
+5. **Analyze changes** in repository between last release and current state
+6. **Update CHANGELOG.md** with all changes before release
+7. **Test build locally** before pushing tags
+8. **Keep credentials secure** - use project-specific tokens
+9. **Test installation** from PyPI after publishing
+10. **Create GitHub Release** after successful publish
+11. **Monitor PyPI stats** and user feedback