Merge pull request #62 from alexander-zuev/feat/api-server

feat: introduce api client <> server separation

Author: alexander-zuev

.env.example

@@ -1,6 +1,9 @@
 # Supabase MCP Server Environment Configuration
 # Copy this file to .env to configure your server
 
+# API Key
+QUERY_API_KEY=your-api-key # thequery.dev API key
+
 # Required for remote Supabase projects (optional for local development)
 SUPABASE_PROJECT_REF=your-project-ref # Your project reference from dashboard URL
 SUPABASE_DB_PASSWORD=your-db-password # Database password for your project
@@ -10,3 +13,7 @@ SUPABASE_REGION=us-east-1 # Region where your Supabase project is hosted
 # Optional configuration
 SUPABASE_ACCESS_TOKEN=your-personal-access-token # Required for Management API tools
 SUPABASE_SERVICE_ROLE_KEY=your-service-role-key # Required for Auth Admin SDK tools
+
+
+# ONLY for local development
+QUERY_API_URL=http://127.0.0.1:8080/v1 # TheQuery.dev API URL when developing locally

.env.test.example

@@ -10,3 +10,6 @@ SUPABASE_DB_PASSWORD=postgres
 
 # Optional: Service role key (for auth tests)
 # SUPABASE_SERVICE_ROLE_KEY=your_service_role_key
+
+# TheQuery.dev API URL
+QUERY_API_URL=http://127.0.0.1:8080/v1

README.md

@@ -35,16 +35,16 @@
 </p>
 
 
-## 🎉 The Future of Supabase MCP Server -> Query MCP
+## 🎉 Query MCP 🎉
 
-**I'm thrilled to announce that Supabase MCP Server is evolving into [thequery.dev](https://thequery.dev)!**
+**I'm thrilled to announce the future of this MCP server - [thequery.dev](https://thequery.dev)!**
 
 While I have big plans for the future, I want to make these commitments super clear:
-- **The core tool will stay free forever** - free & open-source software is how I got into coding
+- **The core tool will stay free forever** - free & open-source software is how I got into coding and intend to keep this MCP server this way
 - **Premium features will be added on top** - enhancing capabilities without limiting existing functionality
-- **First 2,000 early adopters will get special perks** - join early for an exclusive treat!
+- **All 300+ early adopters will get exclusive perks when paid plans land** - stay tuned!
 
-**🚀 BIG v4 Launch Coming Soon!**
+**🚀 Early Access is Live!**
 
 [**👉 Join Early Access at thequery.dev**](https://thequery.dev)
 
@@ -574,6 +574,7 @@ You will have to confirm and approve every high-risk operation explicitly in ord
 - 📝 Automatic versioning of database changes ✅ (v0.3.8)
 - 📖 Radically improved knowledge and tools of api spec ✅ (v0.3.8)
 - ✍️ Improved consistency of migration-related tools for a more organized database vcs ✅ (v0.3.10)
+- 🥳 Query MCP is released (v0.4.0)
 
 
 For a more detailed roadmap, please see this [discussion](https://github.com/alexander-zuev/supabase-mcp-server/discussions/46) on GitHub.

pyproject.toml

@@ -10,7 +10,8 @@ readme = "README.md"
 requires-python = ">=3.12"
 dependencies = [
     "asyncpg>=0.30.0",
-    "mcp[cli]>=1.2.1",
+    "logfire[system-metrics]>=3.12.0",
+    "mcp[cli]>=1.4.1",
     "pglast>=7.3",
     "pyyaml>=6.0.2",
     "supabase>=2.13.0",

smithery.yaml

@@ -11,15 +11,17 @@ startCommand:
       - supabaseProjectRef
       - supabaseDbPassword
       - supabaseRegion
+      - queryApiKey
     properties:
+      queryApiKey:
+        type: string
+        description: "(required) - Your Query API key"
       supabaseProjectRef:
         type: string
-        description: "(required) - Supabase project reference ID - Default: 127.0.0.1:54322"
-        default: "127.0.0.1:54322"
+        description: "(required) - Supabase project reference ID"
       supabaseDbPassword:
         type: string
-        description: "(required) - Database password - Default: postgres"
-        default: "postgres"
+        description: "(required) - Database password"
       supabaseRegion:
         type: string
         description: "(required) - AWS region where your Supabase project is hosted - Default: us-east-1"
@@ -35,6 +37,7 @@ startCommand:
       command: 'supabase-mcp-server',
       args: [],
       env: {
+        QUERY_API_KEY: config.queryApiKey,
         SUPABASE_PROJECT_REF: config.supabaseProjectRef,
         SUPABASE_DB_PASSWORD: config.supabaseDbPassword,
         SUPABASE_REGION: config.supabaseRegion,

supabase_mcp/clients/api_client.py

@@ -0,0 +1,88 @@
+import httpx
+from pydantic import BaseModel
+
+from supabase_mcp.clients.base_http_client import AsyncHTTPClient
+from supabase_mcp.logger import logger
+from supabase_mcp.settings import settings
+
+
+class ApiRoutes:
+    """Routes for the Query API"""
+
+    FEATURES_ACCESS = "/features/{feature_name}/access"
+
+
+class FeatureAccessRequest(BaseModel):
+    """Request for feature access. Later can be extended with additional metadata."""
+
+    feature_name: str
+
+
+class FeatureAccessResponse(BaseModel):
+    """Response for feature access. Later can be extended with additional metadata."""
+
+    access_granted: bool
+
+
+class ApiClient(AsyncHTTPClient):
+    """Client for communicating with the Query API server for premium features.
+
+    To preserve backwards compatibility and ensure a smooth UX for existing users,
+    API key is not required as of now.
+    """
+
+    def __init__(
+        self,
+        query_api_key: str | None = None,
+        query_api_url: str | None = None,
+    ):
+        """Initialize the Query API client"""
+        self.query_api_key = query_api_key or settings.query_api_key
+        self.query_api_url = query_api_url or settings.query_api_url
+        self._check_api_key_set()
+        self.client: httpx.AsyncClient | None = None
+        logger.info(
+            f"✔️ Query API client initialized successfully with URL: {self.query_api_url}, with key: {bool(self.query_api_key)}"
+        )
+
+    async def _ensure_client(self) -> httpx.AsyncClient:
+        """Ensure client exists and is ready for use.
+
+        Creates the client if it doesn't exist yet.
+        Returns the client instance.
+        """
+        if self.client is None:
+            logger.info("Creating new Query API client")
+            self.client = httpx.AsyncClient(
+                base_url=self.query_api_url,
+                headers={"X-API-Key": f"{self.query_api_key}"},
+                timeout=30.0,
+            )
+        logger.info("Returning existing Query API client")
+        return self.client
+
+    async def close(self) -> None:
+        """Close the client and release resources."""
+        if self.client:
+            await self.client.aclose()
+            logger.info("Query API client closed")
+
+    def _check_api_key_set(self) -> None:
+        """Check if the API key is set"""
+        if not self.query_api_key:
+            logger.warning("Query API key is not set. Only free features will be available.")
+            return
+
+    async def check_feature_access(self, feature_name: str) -> FeatureAccessResponse:
+        """Check if the feature is available for the user"""
+
+        try:
+            result = await self.execute_request(
+                method="GET",
+                path=ApiRoutes.FEATURES_ACCESS.format(feature_name=feature_name),
+            )
+            logger.debug(f"Feature access response: {result}")
+            return FeatureAccessResponse.model_validate(result)
+        except Exception as e:
+            logger.error(f"Error checking feature access: {e}")
+            raise e