🚀 v0.2.0: Add debug APIs, docs site, and restructure project

Author: viragtripathi

.github/workflows/docs.yml

@@ -0,0 +1,25 @@
+name: 📘 Deploy Docs to GitHub Pages
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: ⬇️ Checkout
+        uses: actions/checkout@v3
+
+      - name: 📦 Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+
+      - name: 📚 Install mkdocs
+        run: |
+          pip install mkdocs mkdocs-material
+
+      - name: 🚀 Build and deploy
+        run: |
+          mkdocs gh-deploy --force

CHANGELOG.md

@@ -2,6 +2,26 @@
 
 All notable changes to this project will be documented in this file.
 
+## [v0.2.0] - 2025-06-12
+
+### ✨ Added
+- `/debug/info`, `/debug/tables`, `/debug/sql` demo endpoints (gated via `--demo-mode` or `MCP_DEMO_MODE`)
+- `docs/api.md` with full HTTP API reference
+- GitHub Actions CI badge and deployment workflows
+- `mkdocs.yml` and Pages-ready docs site
+- CLI options: `--demo-mode`, `--log-level`
+- ASCII banner on startup
+
+### 🛠 Changed
+- Merged `app/` into `cockroachdb_mcp_server/` for cleaner structure
+- All SQLAlchemy connections now resolve correct dialect (CockroachDB vs PostgreSQL)
+- Improved error handling and schema initialization
+
+### 🧪 Fixed
+- Incorrect usage of `uvicorn.run(..., env=...)` removed
+- Redirects and validation issues in `/debug/sql` fixed
+- Typo in health check route (`/healtz` → `/healthz`)
+
 ---
 
 ## [v0.1.0] - 2025-06-11

README.md

@@ -98,6 +98,10 @@ export CRDB_URL="cockroachdb://root@localhost:26257/defaultdb?sslmode=disable"
 | PUT    | `/contexts/{id}` | Update context    |
 | DELETE | `/contexts/{id}` | Delete context    |
 
+📘 [View full API reference →](docs/api.md)
+
+📘 [View hosted API Docs](https://viragtripathi.github.io/cockroachdb-mcp-server/)
+
 ---
 
 ## 🧱 Schema Auto-Bootstrap

app/__init__.py

@@ -44,17 +44,17 @@ def serve(
     log_level: str = typer.Option(
         "INFO", "--log-level", help="Logging level (DEBUG, INFO, WARN, etc.)"
     ),
+    demo_mode: bool = typer.Option(False, "--demo-mode", help="Enable demo/debug endpoints")
 ):
     """Start the MCP server."""
-    from cockroachdb_mcp_server.logging_config import setup_logging
 
     setup_logging(log_level)
 
     if init_schema or os.getenv("MCP_AUTO_INIT_SCHEMA") == "true":
         typer.echo("Initializing schema...")
         run_schema_init(resolve_crdb_url())
 
-    start_server(host, port, reload)
+    start_server(host, port, reload, demo_mode=demo_mode)
 
 
 def show_banner():

app/main.py

@@ -0,0 +1,27 @@
+import os
+from fastapi import FastAPI
+from cockroachdb_mcp_server.routes import contexts, health, debug
+from cockroachdb_mcp_server import __version__
+
+app = FastAPI(
+    title="CockroachDB MCP Server",
+    version=__version__
+)
+
+app.include_router(health.router)
+app.include_router(contexts.router, prefix="/contexts")
+
+# Optional debug/demo endpoints
+if os.getenv("MCP_DEMO_MODE") == "true":
+    print("[debug] Mounting /debug routes")
+    app.include_router(debug.router, prefix="/debug")
+
+print(f"[debug] MCP_DEMO_MODE = {os.getenv('MCP_DEMO_MODE')}")
+
+print("[debug] Registered paths:")
+for route in app.routes:
+    print(f" - {route.path}")
+
+@app.get("/")
+def root():
+    return {"message": "MCP Server is running"}

cockroachdb_mcp_server/cli.py

@@ -1,7 +1,7 @@
 from fastapi import APIRouter, HTTPException
-from app.models.context import ContextRequest
+from cockroachdb_mcp_server.models.context import ContextRequest
 from sqlalchemy import text
-from app.db.db_connection import get_sqlalchemy_engine
+from cockroachdb_mcp_server.db.db_connection import get_sqlalchemy_engine
 from uuid import UUID
 import json