pglens 0.1.0__tar.gz

pglens-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,33 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v4
+      - run: uv sync --group dev
+      - run: uv run ruff check .
+      - run: uv run ruff format --check .
+
+  typecheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v4
+      - run: uv sync --group dev
+      - run: uv run mypy .
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v4
+      - run: uv sync --group dev
+      - run: uv run pytest tests/ -v

pglens-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,50 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Build sdist and wheel
+        run: uv build
+
+      - name: Upload dist artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+
+    environment:
+      name: pypi
+      url: https://pypi.org/project/pglens/
+
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Download dist artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

pglens-0.1.0/.gitignore

@@ -0,0 +1,25 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+dist/
+build/
+
+# Virtual environments
+.venv/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+
+# mypy
+.mypy_cache/
+
+# ruff
+.ruff_cache/

pglens-0.1.0/LICENSE

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

pglens-0.1.0/PKG-INFO

@@ -0,0 +1,186 @@
+Metadata-Version: 2.4
+Name: pglens
+Version: 0.1.0
+Summary: PostgreSQL MCP server for schema inspection, data exploration, and query execution.
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.11
+Requires-Dist: asyncpg>=0.29
+Requires-Dist: mcp>=1.0
+Description-Content-Type: text/markdown
+
+# pglens
+
+A PostgreSQL MCP server with tools for schema inspection, data exploration, query execution, and database health monitoring.
+
+## Motivation
+
+Most Postgres MCP servers expose `query` and `list_tables`, and that's about it. Agents end up guessing column names, enum values, and join paths, which leads to multiple failed attempts before landing on working SQL.
+
+pglens adds the tools that close those gaps: checking what values actually exist in a column, discovering foreign-key relationships, previewing sample data, and validating query plans. The idea is straightforward: let the agent look before it leaps.
+
+## Tools
+
+### Schema and discovery
+
+| Tool | What it does |
+|---|---|
+| `list_tables` | Tables with row counts and descriptions |
+| `list_views` | Views with their SQL definitions |
+| `list_extensions` | Installed extensions and versions |
+| `describe_table` | Columns, types, PKs, FKs, indexes, check constraints |
+| `find_related_tables` | FK relationships in both directions |
+| `list_functions` | Stored functions/procedures with source code |
+| `list_triggers` | Triggers on a table with definitions and status |
+| `list_policies` | Row-level security policies on a table |
+
+### Data exploration
+
+| Tool | What it does |
+|---|---|
+| `sample_rows` | Random rows from a table |
+| `column_values` | Distinct values with frequency counts |
+| `search_data` | Case-insensitive search across text columns |
+| `search_columns` | Find columns by name across all tables |
+| `search_enum_values` | Enum types and their allowed values |
+
+### Query execution
+
+| Tool | What it does |
+|---|---|
+| `explain_query` | Query plan without execution |
+| `query` | Read-only SQL, capped at 500 rows |
+
+### Performance and health
+
+| Tool | What it does |
+|---|---|
+| `table_stats` | Index hit rates, dead tuples, vacuum timestamps |
+| `table_sizes` | Disk usage per table, ranked by size |
+| `unused_indexes` | Indexes that are never scanned |
+| `bloat_stats` | Dead tuples, vacuum status, wraparound risk |
+| `active_queries` | Currently running sessions and their queries |
+| `blocking_locks` | Lock wait chains (who blocks whom) |
+| `sequence_health` | Sequences approaching exhaustion |
+| `matview_status` | Materialized view freshness and refresh eligibility |
+
+### Safety before DDL
+
+| Tool | What it does |
+|---|---|
+| `object_dependencies` | What depends on a given object (views, functions, constraints) |
+
+There is also a `query_guide` prompt that describes a reasonable workflow for using these tools together.
+
+### A note on `column_values`
+
+Agents frequently write `WHERE status = 'active'` when the actual value is `'Active'` or `'enabled'`. `column_values` returns the real distinct values in a column with counts, so the agent can pick the right one instead of guessing.
+
+## Installation
+
+```bash
+pip install pglens
+```
+
+Or with [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv pip install pglens
+```
+
+## Usage
+
+pglens reads standard PostgreSQL environment variables. No config files, no flags.
+
+```bash
+export PGHOST=localhost
+export PGUSER=myuser
+export PGPASSWORD=mypassword
+export PGDATABASE=mydb
+
+pglens
+```
+
+The server uses stdio transport.
+
+### Claude Desktop
+
+```json
+{
+  "mcpServers": {
+    "pglens": {
+      "command": "pglens",
+      "env": {
+        "PGHOST": "localhost",
+        "PGPORT": "5432",
+        "PGUSER": "myuser",
+        "PGPASSWORD": "mypassword",
+        "PGDATABASE": "mydb"
+      }
+    }
+  }
+}
+```
+
+### Claude Code
+
+```json
+{
+  "mcpServers": {
+    "pglens": {
+      "command": "pglens",
+      "env": {
+        "PGHOST": "localhost",
+        "PGDATABASE": "mydb"
+      }
+    }
+  }
+}
+```
+
+### Zed
+
+```json
+{
+  "context_servers": {
+    "pglens": {
+      "command": {
+        "path": "pglens",
+        "args": []
+      }
+    }
+  }
+}
+```
+
+## Architecture
+
+```
+mcp_adapter.py  (MCP tool definitions, lifespan)
+    |
+asyncpg_adapter.py  (SQL queries, asyncpg pool)
+    |
+PostgreSQL
+```
+
+`AsyncpgDatabase` holds the asyncpg pool and all query methods. The MCP layer is a thin wrapper that delegates to it. All queries use pure `pg_catalog` introspection — no PostgreSQL extensions required.
+
+## Adding a tool
+
+1. Add a method to `AsyncpgDatabase` in `adapters/asyncpg_adapter.py`
+2. Add a `@mcp.tool()` function in `adapters/mcp_adapter.py`
+
+## Safety
+
+- All user-influenced queries run inside `readonly=True` transactions
+- Table and column identifiers are escaped via PostgreSQL's `quote_ident()`
+- No DDL tools are exposed
+
+## Requirements
+
+- Python 3.11+
+- PostgreSQL
+
+## License
+
+MIT

pglens-0.1.0/README.md

@@ -0,0 +1,175 @@
+# pglens
+
+A PostgreSQL MCP server with tools for schema inspection, data exploration, query execution, and database health monitoring.
+
+## Motivation
+
+Most Postgres MCP servers expose `query` and `list_tables`, and that's about it. Agents end up guessing column names, enum values, and join paths, which leads to multiple failed attempts before landing on working SQL.
+
+pglens adds the tools that close those gaps: checking what values actually exist in a column, discovering foreign-key relationships, previewing sample data, and validating query plans. The idea is straightforward: let the agent look before it leaps.
+
+## Tools
+
+### Schema and discovery
+
+| Tool | What it does |
+|---|---|
+| `list_tables` | Tables with row counts and descriptions |
+| `list_views` | Views with their SQL definitions |
+| `list_extensions` | Installed extensions and versions |
+| `describe_table` | Columns, types, PKs, FKs, indexes, check constraints |
+| `find_related_tables` | FK relationships in both directions |
+| `list_functions` | Stored functions/procedures with source code |
+| `list_triggers` | Triggers on a table with definitions and status |
+| `list_policies` | Row-level security policies on a table |
+
+### Data exploration
+
+| Tool | What it does |
+|---|---|
+| `sample_rows` | Random rows from a table |
+| `column_values` | Distinct values with frequency counts |
+| `search_data` | Case-insensitive search across text columns |
+| `search_columns` | Find columns by name across all tables |
+| `search_enum_values` | Enum types and their allowed values |
+
+### Query execution
+
+| Tool | What it does |
+|---|---|
+| `explain_query` | Query plan without execution |
+| `query` | Read-only SQL, capped at 500 rows |
+
+### Performance and health
+
+| Tool | What it does |
+|---|---|
+| `table_stats` | Index hit rates, dead tuples, vacuum timestamps |
+| `table_sizes` | Disk usage per table, ranked by size |
+| `unused_indexes` | Indexes that are never scanned |
+| `bloat_stats` | Dead tuples, vacuum status, wraparound risk |
+| `active_queries` | Currently running sessions and their queries |
+| `blocking_locks` | Lock wait chains (who blocks whom) |
+| `sequence_health` | Sequences approaching exhaustion |
+| `matview_status` | Materialized view freshness and refresh eligibility |
+
+### Safety before DDL
+
+| Tool | What it does |
+|---|---|
+| `object_dependencies` | What depends on a given object (views, functions, constraints) |
+
+There is also a `query_guide` prompt that describes a reasonable workflow for using these tools together.
+
+### A note on `column_values`
+
+Agents frequently write `WHERE status = 'active'` when the actual value is `'Active'` or `'enabled'`. `column_values` returns the real distinct values in a column with counts, so the agent can pick the right one instead of guessing.
+
+## Installation
+
+```bash
+pip install pglens
+```
+
+Or with [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv pip install pglens
+```
+
+## Usage
+
+pglens reads standard PostgreSQL environment variables. No config files, no flags.
+
+```bash
+export PGHOST=localhost
+export PGUSER=myuser
+export PGPASSWORD=mypassword
+export PGDATABASE=mydb
+
+pglens
+```
+
+The server uses stdio transport.
+
+### Claude Desktop
+
+```json
+{
+  "mcpServers": {
+    "pglens": {
+      "command": "pglens",
+      "env": {
+        "PGHOST": "localhost",
+        "PGPORT": "5432",
+        "PGUSER": "myuser",
+        "PGPASSWORD": "mypassword",
+        "PGDATABASE": "mydb"
+      }
+    }
+  }
+}
+```
+
+### Claude Code
+
+```json
+{
+  "mcpServers": {
+    "pglens": {
+      "command": "pglens",
+      "env": {
+        "PGHOST": "localhost",
+        "PGDATABASE": "mydb"
+      }
+    }
+  }
+}
+```
+
+### Zed
+
+```json
+{
+  "context_servers": {
+    "pglens": {
+      "command": {
+        "path": "pglens",
+        "args": []
+      }
+    }
+  }
+}
+```
+
+## Architecture
+
+```
+mcp_adapter.py  (MCP tool definitions, lifespan)
+    |
+asyncpg_adapter.py  (SQL queries, asyncpg pool)
+    |
+PostgreSQL
+```
+
+`AsyncpgDatabase` holds the asyncpg pool and all query methods. The MCP layer is a thin wrapper that delegates to it. All queries use pure `pg_catalog` introspection — no PostgreSQL extensions required.
+
+## Adding a tool
+
+1. Add a method to `AsyncpgDatabase` in `adapters/asyncpg_adapter.py`
+2. Add a `@mcp.tool()` function in `adapters/mcp_adapter.py`
+
+## Safety
+
+- All user-influenced queries run inside `readonly=True` transactions
+- Table and column identifiers are escaped via PostgreSQL's `quote_ident()`
+- No DDL tools are exposed
+
+## Requirements
+
+- Python 3.11+
+- PostgreSQL
+
+## License
+
+MIT

pglens-0.1.0/pyproject.toml

@@ -0,0 +1,42 @@
+[project]
+name = "pglens"
+version = "0.1.0"
+description = "PostgreSQL MCP server for schema inspection, data exploration, and query execution."
+readme = "README.md"
+requires-python = ">=3.11"
+license = "MIT"
+dependencies = [
+    "asyncpg>=0.29",
+    "mcp>=1.0",
+]
+
+[project.scripts]
+pglens = "pglens.__main__:main"
+
+[dependency-groups]
+dev = [
+    "asyncpg-stubs>=0.29",
+    "mypy>=1.10",
+    "pytest>=8.0",
+    "pytest-asyncio>=0.24",
+    "ruff>=0.8",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/pglens"]
+
+[tool.ruff]
+line-length = 100
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+
+[tool.mypy]
+strict = true

pglens-0.1.0/src/pglens/__init__.py

@@ -0,0 +1,3 @@
+from pglens.adapters.mcp_adapter import mcp
+
+__all__ = ["mcp"]

pglens-0.1.0/src/pglens/__main__.py

@@ -0,0 +1,11 @@
+"""Entry point: python -m pglens / uv run pglens."""
+
+from pglens.adapters.mcp_adapter import mcp
+
+
+def main() -> None:
+    mcp.run(transport="stdio")
+
+
+if __name__ == "__main__":
+    main()