mcp-read-only-sql 0.1.0__tar.gz

mcp_read_only_sql-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,201 @@
+name: Publish
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v5
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v6
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v7
+      with:
+        version: "latest"
+
+    - name: Cache uv environment
+      uses: actions/cache@v5
+      with:
+        path: |
+          ~/.cache/uv
+          .venv
+        key: ${{ runner.os }}-uv-publish-py${{ matrix.python-version }}-${{ hashFiles('uv.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-uv-publish-py${{ matrix.python-version }}-
+
+    - name: Install dependencies
+      run: |
+        uv sync --extra dev
+
+    - name: Run linter
+      run: |
+        uv run ruff check src/mcp_read_only_sql/ tests/
+
+    - name: Install system dependencies for CLI connectors
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y postgresql-client
+
+        sudo apt-get install -y apt-transport-https ca-certificates curl gnupg
+        curl -fsSL 'https://packages.clickhouse.com/rpm/lts/repodata/repomd.xml.key' | sudo gpg --dearmor -o /usr/share/keyrings/clickhouse-keyring.gpg
+        echo "deb [signed-by=/usr/share/keyrings/clickhouse-keyring.gpg] https://packages.clickhouse.com/deb stable main" | sudo tee /etc/apt/sources.list.d/clickhouse.list
+        sudo apt-get update
+        sudo apt-get install -y clickhouse-client
+
+        sudo apt-get install -y sshpass
+
+    - name: Run tests
+      run: |
+        ./run_tests.sh
+      env:
+        PYTHONUNBUFFERED: 1
+
+  package-smoke:
+    runs-on: ubuntu-latest
+    needs: test
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v5
+
+    - name: Set up Python 3.12
+      uses: actions/setup-python@v6
+      with:
+        python-version: "3.12"
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v7
+      with:
+        version: "latest"
+
+    - name: Validate tag matches package version
+      run: |
+        package_version="$(python -c 'import tomllib; from pathlib import Path; print(tomllib.loads(Path("pyproject.toml").read_text(encoding="utf-8"))["project"]["version"])')"
+        tag_version="${GITHUB_REF_NAME#v}"
+
+        if [ "$package_version" != "$tag_version" ]; then
+          echo "Tag version $tag_version does not match pyproject.toml version $package_version" >&2
+          exit 1
+        fi
+
+    - name: Build package artifacts
+      run: |
+        uv build
+
+    - name: Smoke test wheel
+      run: |
+        tmp_dir="$(mktemp -d)"
+        trap 'rm -rf "$tmp_dir"' EXIT
+        uvx --from dist/*.whl mcp-read-only-sql \
+          --config-dir "$tmp_dir/config" \
+          --state-dir "$tmp_dir/state" \
+          --cache-dir "$tmp_dir/cache" \
+          --write-sample-config
+        test -f "$tmp_dir/config/connections.yaml"
+        uvx --from dist/*.whl mcp-read-only-sql \
+          --config-dir "$tmp_dir/config" \
+          --state-dir "$tmp_dir/state" \
+          --cache-dir "$tmp_dir/cache" \
+          --print-paths
+        uvx --from dist/*.whl mcp-read-only-sql import-dbeaver \
+          --config-dir "$tmp_dir/config" \
+          --state-dir "$tmp_dir/state" \
+          --cache-dir "$tmp_dir/cache" \
+          --print-paths
+        uvx --from dist/*.whl mcp-read-only-sql validate-config \
+          --config-dir "$tmp_dir/config" \
+          --state-dir "$tmp_dir/state" \
+          --cache-dir "$tmp_dir/cache" \
+          --print-paths
+        uvx --from dist/*.whl mcp-read-only-sql test-connection \
+          --config-dir "$tmp_dir/config" \
+          --state-dir "$tmp_dir/state" \
+          --cache-dir "$tmp_dir/cache" \
+          --print-paths
+        uvx --from dist/*.whl mcp-read-only-sql test-ssh-tunnel \
+          --config-dir "$tmp_dir/config" \
+          --state-dir "$tmp_dir/state" \
+          --cache-dir "$tmp_dir/cache" \
+          --print-paths
+
+    - name: Smoke test sdist
+      run: |
+        tmp_dir="$(mktemp -d)"
+        trap 'rm -rf "$tmp_dir"' EXIT
+        uvx --from dist/*.tar.gz mcp-read-only-sql \
+          --config-dir "$tmp_dir/config" \
+          --state-dir "$tmp_dir/state" \
+          --cache-dir "$tmp_dir/cache" \
+          --write-sample-config
+        test -f "$tmp_dir/config/connections.yaml"
+        uvx --from dist/*.tar.gz mcp-read-only-sql \
+          --config-dir "$tmp_dir/config" \
+          --state-dir "$tmp_dir/state" \
+          --cache-dir "$tmp_dir/cache" \
+          --print-paths
+        uvx --from dist/*.tar.gz mcp-read-only-sql import-dbeaver \
+          --config-dir "$tmp_dir/config" \
+          --state-dir "$tmp_dir/state" \
+          --cache-dir "$tmp_dir/cache" \
+          --print-paths
+        uvx --from dist/*.tar.gz mcp-read-only-sql validate-config \
+          --config-dir "$tmp_dir/config" \
+          --state-dir "$tmp_dir/state" \
+          --cache-dir "$tmp_dir/cache" \
+          --print-paths
+        uvx --from dist/*.tar.gz mcp-read-only-sql test-connection \
+          --config-dir "$tmp_dir/config" \
+          --state-dir "$tmp_dir/state" \
+          --cache-dir "$tmp_dir/cache" \
+          --print-paths
+        uvx --from dist/*.tar.gz mcp-read-only-sql test-ssh-tunnel \
+          --config-dir "$tmp_dir/config" \
+          --state-dir "$tmp_dir/state" \
+          --cache-dir "$tmp_dir/cache" \
+          --print-paths
+
+  publish:
+    runs-on: ubuntu-latest
+    needs:
+      - test
+      - package-smoke
+    permissions:
+      contents: read
+      id-token: write
+    environment:
+      name: pypi
+      url: https://pypi.org/p/mcp-read-only-sql
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v5
+
+    - name: Set up Python 3.12
+      uses: actions/setup-python@v6
+      with:
+        python-version: "3.12"
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v7
+      with:
+        version: "latest"
+
+    - name: Build package artifacts
+      run: |
+        uv build
+
+    - name: Publish to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

mcp_read_only_sql-0.1.0/.github/workflows/test.yml

@@ -0,0 +1,174 @@
+name: Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v5
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v6
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v7
+      with:
+        version: "latest"
+
+    - name: Cache uv environment
+      uses: actions/cache@v5
+      with:
+        path: |
+          ~/.cache/uv
+          .venv
+        key: ${{ runner.os }}-uv-py${{ matrix.python-version }}-${{ hashFiles('uv.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-uv-py${{ matrix.python-version }}-
+
+    - name: Install dependencies
+      run: |
+        uv sync --extra dev
+
+    - name: Run linter
+      run: |
+        uv run ruff check src/mcp_read_only_sql/ tests/
+
+    - name: Install system dependencies for CLI connectors
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y postgresql-client
+
+        sudo apt-get install -y apt-transport-https ca-certificates curl gnupg
+        curl -fsSL 'https://packages.clickhouse.com/rpm/lts/repodata/repomd.xml.key' | sudo gpg --dearmor -o /usr/share/keyrings/clickhouse-keyring.gpg
+        echo "deb [signed-by=/usr/share/keyrings/clickhouse-keyring.gpg] https://packages.clickhouse.com/deb stable main" | sudo tee /etc/apt/sources.list.d/clickhouse.list
+        sudo apt-get update
+        sudo apt-get install -y clickhouse-client
+
+        sudo apt-get install -y sshpass
+
+    - name: Run tests
+      run: |
+        ./run_tests.sh
+      env:
+        PYTHONUNBUFFERED: 1
+
+    - name: Upload test results
+      if: always()
+      uses: actions/upload-artifact@v7
+      with:
+        name: test-results-py${{ matrix.python-version }}
+        path: |
+          test-results/
+        if-no-files-found: ignore
+
+    - name: Clean up
+      if: always()
+      run: |
+        docker compose --profile test down || true
+
+  package-smoke:
+    runs-on: ubuntu-latest
+    needs: test
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v5
+
+    - name: Set up Python 3.12
+      uses: actions/setup-python@v6
+      with:
+        python-version: "3.12"
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v7
+      with:
+        version: "latest"
+
+    - name: Build package artifacts
+      run: |
+        uv build
+
+    - name: Smoke test wheel
+      run: |
+        tmp_dir="$(mktemp -d)"
+        trap 'rm -rf "$tmp_dir"' EXIT
+        uvx --from dist/*.whl mcp-read-only-sql \
+          --config-dir "$tmp_dir/config" \
+          --state-dir "$tmp_dir/state" \
+          --cache-dir "$tmp_dir/cache" \
+          --write-sample-config
+        test -f "$tmp_dir/config/connections.yaml"
+        uvx --from dist/*.whl mcp-read-only-sql \
+          --config-dir "$tmp_dir/config" \
+          --state-dir "$tmp_dir/state" \
+          --cache-dir "$tmp_dir/cache" \
+          --print-paths
+        uvx --from dist/*.whl mcp-read-only-sql import-dbeaver \
+          --config-dir "$tmp_dir/config" \
+          --state-dir "$tmp_dir/state" \
+          --cache-dir "$tmp_dir/cache" \
+          --print-paths
+        uvx --from dist/*.whl mcp-read-only-sql validate-config \
+          --config-dir "$tmp_dir/config" \
+          --state-dir "$tmp_dir/state" \
+          --cache-dir "$tmp_dir/cache" \
+          --print-paths
+        uvx --from dist/*.whl mcp-read-only-sql test-connection \
+          --config-dir "$tmp_dir/config" \
+          --state-dir "$tmp_dir/state" \
+          --cache-dir "$tmp_dir/cache" \
+          --print-paths
+        uvx --from dist/*.whl mcp-read-only-sql test-ssh-tunnel \
+          --config-dir "$tmp_dir/config" \
+          --state-dir "$tmp_dir/state" \
+          --cache-dir "$tmp_dir/cache" \
+          --print-paths
+
+    - name: Smoke test sdist
+      run: |
+        tmp_dir="$(mktemp -d)"
+        trap 'rm -rf "$tmp_dir"' EXIT
+        uvx --from dist/*.tar.gz mcp-read-only-sql \
+          --config-dir "$tmp_dir/config" \
+          --state-dir "$tmp_dir/state" \
+          --cache-dir "$tmp_dir/cache" \
+          --write-sample-config
+        test -f "$tmp_dir/config/connections.yaml"
+        uvx --from dist/*.tar.gz mcp-read-only-sql \
+          --config-dir "$tmp_dir/config" \
+          --state-dir "$tmp_dir/state" \
+          --cache-dir "$tmp_dir/cache" \
+          --print-paths
+        uvx --from dist/*.tar.gz mcp-read-only-sql import-dbeaver \
+          --config-dir "$tmp_dir/config" \
+          --state-dir "$tmp_dir/state" \
+          --cache-dir "$tmp_dir/cache" \
+          --print-paths
+        uvx --from dist/*.tar.gz mcp-read-only-sql validate-config \
+          --config-dir "$tmp_dir/config" \
+          --state-dir "$tmp_dir/state" \
+          --cache-dir "$tmp_dir/cache" \
+          --print-paths
+        uvx --from dist/*.tar.gz mcp-read-only-sql test-connection \
+          --config-dir "$tmp_dir/config" \
+          --state-dir "$tmp_dir/state" \
+          --cache-dir "$tmp_dir/cache" \
+          --print-paths
+        uvx --from dist/*.tar.gz mcp-read-only-sql test-ssh-tunnel \
+          --config-dir "$tmp_dir/config" \
+          --state-dir "$tmp_dir/state" \
+          --cache-dir "$tmp_dir/cache" \
+          --print-paths

mcp_read_only_sql-0.1.0/.gitignore

@@ -0,0 +1,43 @@
+# Environment variables
+.env
+.env.local
+.env.bak*
+
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.venv/
+.cache/
+
+# uv
+uv.lock
+.uv-cache/
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# Local Claude settings
+.claude/
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+test-results/
+
+# Connections
+connections.yaml
+connections.yaml.bak*
+connections.yaml.bak.*
+
+# Logs
+*.log
+
+# OS
+.DS_Store

mcp_read_only_sql-0.1.0/.mcp.json

@@ -0,0 +1,9 @@
+{
+  "mcpServers": {
+    "mcp-read-only-sql": {
+      "command": "uvx",
+      "args": ["--from", ".", "mcp-read-only-sql"],
+      "env": {}
+    }
+  }
+}

mcp_read_only_sql-0.1.0/AGENTS.md

@@ -0,0 +1,25 @@
+# Repository Guidelines
+
+## Project Structure & Module Organization
+`src/mcp_read_only_sql/server.py` exposes the MCP entry point, while `src/mcp_read_only_sql/connectors/` hosts the PostgreSQL and ClickHouse adapters. Cross-cutting helpers (`ssh_tunnel.py`, `sql_guard.py`, TSV formatting) live in `src/mcp_read_only_sql/utils/`. Configuration tooling, including DBeaver import and manifest validation, sits in `src/mcp_read_only_sql/config/` and `src/mcp_read_only_sql/tools/`. Tests are grouped in `tests/`, and Docker fixtures for integration runs reside in `docker/`. The package ships a sample `connections.yaml`, and runtime config lives under `~/.config/lukleh/mcp-read-only-sql/`.
+
+## Build, Test, and Development Commands
+- `uv sync --extra dev` — install runtime and development dependencies.
+- `uv run mcp-read-only-sql` or `just run` — start the MCP server with the resolved runtime config directory.
+- `uv run mcp-read-only-sql --write-sample-config` or `just write-sample-config` — bootstrap `connections.yaml` without cloning-path assumptions.
+- `uv run mcp-read-only-sql import-dbeaver ...` or `just import-dbeaver` — convert a DBeaver workspace into `connections.yaml`.
+- `just validate` — lint `connections.yaml` against the schema and safety checks.
+- `just test` — spin up Dockerized fixtures and execute the full pytest suite via `./run_tests.sh`.
+- `uv run python -m pytest tests/test_sql_guard.py` — run an individual module when iterating quickly.
+
+## Coding Style & Naming Conventions
+Target Python 3.11+, four-space indentation, and Unix newlines. Format with `uv run black .` and lint via `uv run ruff check .`; CI mirrors these checks. Modules and callables use snake_case, classes PascalCase (e.g., `TestReadOnlyGuards`), and immutable settings uppercase (`DEFAULT_QUERY_TIMEOUT`). Apply type hints on public surfaces and keep docstrings brief, emphasising read-only guarantees.
+
+## Testing Guidelines
+Pytest discovers `test_*.py` modules, `Test*` classes, and `test_*` functions per `pytest.ini`. Use the built-in markers (`security`, `cli`, `python`, `ssh`, `slow`) to scope runs, e.g. `pytest -m "security and not slow"`. A 30s default timeout applies, so tear down tunnels and subprocesses explicitly. `just test` emits JUnit XML at `test-results/pytest.xml` for CI uploads.
+
+## Commit & Pull Request Guidelines
+Recent commits favour imperative, concise subjects (“Refactor PostgreSQL read-only guard into shared utility”). Keep changes focused and explain security or connector impacts in the body when needed. Pull requests should describe motivation, list affected modules or scripts, link issues, and attach logs or screenshots for operational updates.
+
+## Security & Configuration Tips
+Do not relax safeguards in `src/mcp_read_only_sql/utils/sql_guard.py` or connector factories without matching tests. Treat `connections.yaml` as sensitive; the server stores database and SSH passwords directly in that file, so keep it private and user-readable only. Use the SSH tunnel helpers instead of bespoke subprocesses to preserve timeout and read-only enforcement.

mcp_read_only_sql-0.1.0/LICENSE

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