gateway

<div align="center">  &nbsp; <a href="https://discord.gg/XFhaUG4F5x"><img src="https://dcbadge.limes.pink/api/server/https://discord.gg/XFhaUG4F5x" height="20"></a> &nbsp;&nbsp;<a href="https://t.me/+TM3T1SikjzA4ZWVi"><img src="https://img.shields.io/badge/telegram-%E2%9D%A4%EF%B8%8F-252850?style=plastic&logo=telegram" height=20></a> &nbsp;&nbsp; <a href="https://docs.centralmind.ai"><img src="https://img.shields.io/badge/Full%20Documentation-blue?style=for-the-badge&logo=rocket&logoColor=white" height="20"></a>&nbsp;&nbsp; <a href="https://cursor.com/install-mcp?name=CentralMind%20Database%20Gateway&config=eyJjb21tYW5kIjoiZG9ja2VyIHJ1biAtaSAtLXBsYXRmb3JtIGxpbnV4L2FtZDY0IGdoY3IuaW8vY2VudHJhbG1pbmQvZ2F0ZXdheTp2MC4yLjE4IC0tY29ubmVjdGlvbi1zdHJpbmcgcG9zdGdyZXNxbDovL215X3VzZXI6bXlfcGFzc0Bsb2NhbGhvc3Q6NTQzMi9teWRiIHN0YXJ0IHN0ZGlvIn0%3D"><img height="21" src="https://cursor.com/deeplink/mcp-install-dark.svg"></a> </div> <h2 align="center">CentralMind Gateway: Create API or MCP Server in Minutes</h2> 🚀 Interactive Demo avialable here: https://centralmind.ai ## What is Centralmind/Gateway Simple way to expose your database to AI-Agent via MCP or OpenAPI 3.1 protocols. ```bash docker run --platform linux/amd64 -p 9090:9090 \ ghcr.io/centralmind/gateway:v0.2.18 start \ --connection-string "postgres://db-user:db-password@db-host/db-name?sslmode=require" ``` This will run for you an API: ```shell INFO Gateway server started successfully! INFO MCP SSE server for AI agents is running at: http://localhost:9090/sse INFO REST API with Swagger UI is available at: http://localhost:9090/ ``` Which you can use inside your AI Agent:  Gateway will generate AI optimized API. ## Why Centralmind/Gateway AI agents and LLM-powered applications need fast, secure access to data. We're building an API layer that automatically generates secure, LLM-optimized APIs for your structured data. - Quickly start with MCP or OpenAPI, or use Direct/Raw SQL APIs - Filters out PII and sensitive data to ensure compliance with GDPR, CPRA, SOC 2, and other regulations - Adds traceability and auditing capabilities, ensuring AI applications aren't black boxes and allowing security teams to maintain control - Optimized for AI workloads: supports the Model Context Protocol (MCP) with enhanced metadata to help AI agents understand APIs, along with built-in caching and security features It can be useful during development, when an LLM needs to create, adjust, or query data from your database. In analytical scenarios, it enables you to chat with your database or data warehouse. Enrich your AI agents with data from your database using remote function/tool calling.  ## Features - ⚡ **Automatic API Generation** – Creates APIs automatically using LLM based on table schema and sampled data - 🗄️ **Structured Database Support** – Supports <a href="https://docs.centralmind.ai/connectors/postgres/">PostgreSQL</a>, <a href="https://docs.centralmind.ai/connectors/mysql/">MySQL</a>, <a href="https://docs.centralmind.ai/connectors/clickhouse/">ClickHouse</a>, <a href="https://docs.centralmind.ai/connectors/snowflake/">Snowflake</a>, <a href="https://docs.centralmind.ai/connectors/mssql/">MSSQL</a>, <a href="https://docs.centralmind.ai/connectors/bigquery/">BigQuery</a>, <a href="https://docs.centralmind.ai/connectors/oracle/">Oracle Database</a>, <a href="https://docs.centralmind.ai/connectors/sqlite/">SQLite</a>, <a href="https://docs.centralmind.ai/connectors/sqlite/">ElasticSearch</a> - 🌍 **Multiple Protocol Support** – Provides APIs as REST or MCP Server including SSE mode - 🔐 **Authentication Options** – Built-in support for <a href="https://docs.centralmind.ai/plugins/api_keys/">API keys</a> and <a href="https://docs.centralmind.ai/plugins/oauth/">OAuth</a> - 🔒 **PII Protection** – Implements <a href="https://docs.centralmind.ai/plugins/pii_remover/">regex plugin</a> or <a href="https://docs.centralmind.ai/plugins/presidio_anonymizer/">Microsoft Presidio plugin</a> for PII and sensitive data redaction - 👀 **Comprehensive Monitoring** – Integration with <a href="https://docs.centralmind.ai/plugins/otel/">OpenTelemetry (OTel)</a> for request tracking and audit trails - 📦 **Local & On-Premises** – Support for <a href="https://docs.centralmind.ai/providers/local-models/">self-hosted LLMs</a> through configurable AI endpoints and models - 🤖 **Multiple AI Providers Support** - Support for [OpenAI](https://docs.centralmind.ai/providers/openai), [Anthropic](https://docs.centralmind.ai/providers/anthropic), [Amazon Bedrock](https://docs.centralmind.ai/providers/bedrock), [Google Gemini](https://docs.centralmind.ai/providers/gemini) & [Google VertexAI](https://docs.centralmind.ai/providers/anthropic-vertexai) - ⚡ **Flexible Configuration** – Easily extensible via YAML configuration and plugin system - 📜 **API Documentation** – Auto-generated Swagger documentation and OpenAPI 3.1.0 specification - 🔑 **Row-Level Security (RLS)** – Fine-grained data access control using <a href="https://docs.centralmind.ai/plugins/lua_rls/">Lua scripts</a> - 🏎️ **Performance Optimization** – Implements time-based and <a href="https://docs.centralmind.ai/plugins/lru_cache/">LRU caching</a> strategies ## How it Works <div align="center">  </div> ### 1. Connect & Discover Gateway connects to your structured databases like PostgreSQL and automatically analyzes the schema and data samples to generate an optimized API structure based on your prompt. LLM is used only on discovery stage to produce API configuration. The tool uses [AI Providers](https://docs.centralmind.ai/providers) to generate the API configuration while ensuring security through PII detection. ### 2. Deploy Gateway supports multiple deployment options from standalone binary, docker or <a href="https://docs.centralmind.ai/example/k8s/">Kubernetes</a>. Check our <a href="https://docs.centralmind.ai/docs/content/getting-started/launching-api/">launching guide</a> for detailed instructions. The system uses YAML configuration and plugins for easy customization. ### 3. Use & Integrate Access your data through REST APIs or Model Context Protocol (MCP) with built-in security features. Gateway seamlessly integrates with AI models and applications like <a href="https://docs.centralmind.ai/docs/content/integration/langchain/">LangChain</a>, <a href="https://docs.centralmind.ai/docs/content/integration/chatgpt/">OpenAI</a> and <a href="https://docs.centralmind.ai/docs/content/integration/claude-desktop/">Claude Desktop</a> using function calling or <a href="https://docs.centralmind.ai/docs/content/integration/cursor/">Cursor</a> through MCP. You can also <a href="https://docs.centralmind.ai/plugins/otel/">setup telemetry</a> to local or remote destination in otel format. ## Documentation ### Getting Started - <a href="https://docs.centralmind.ai/docs/content/getting-started/quickstart/">Quickstart Guide</a> - <a href="https://docs.centralmind.ai/docs/content/getting-started/installation/">Installation Instructions</a> - <a href="https://docs.centralmind.ai/docs/content/getting-started/generating-api/">API Generation Guide</a> - <a href="https://docs.centralmind.ai/docs/content/getting-started/launching-api/">API Launch Guide</a> ### Additional Resources - <a href="https://docs.centralmind.ai/docs/content/integration/chatgpt/">ChatGPT Integration Guide</a> - <a href="https://docs.centralmind.ai/connectors/">Database Connector Documentation</a> - <a href="https://docs.centralmind.ai/plugins/">Plugin Documentation</a> ## How to Build ```shell # Clone the repository git clone https://github.com/centralmind/gateway.git # Navigate to project directory cd gateway # Install dependencies go mod download # Build the project go build . ``` ## API Generation Gateway uses LLM models to generate your API configuration. Follow these steps: Choose one of our supported AI providers: - [OpenAI](https://docs.centralmind.ai/providers/openai) and all OpenAI-compatible providers - [Anthropic](https://docs.centralmind.ai/providers/anthropic) - [Amazon Bedrock](https://docs.centralmind.ai/providers/bedrock) - [Google Vertex AI (Anthropic)](https://docs.centralmind.ai/providers/anthropic-vertexai) - [Google Gemini](https://docs.centralmind.ai/providers/gemini) Google Gemini provides a generous **free tier**. You can obtain an API key by visiting Google AI Studio: - [Google AI Studio](https://aistudio.google.com/apikey) Once logged in, you can create an API key in the API section of AI Studio. The free tier includes a generous monthly token allocation, making it accessible for development and testing purposes. Configure AI provider authorization. For Google Gemini, set an API key. ```bash export GEMINI_API_KEY='yourkey' ``` 2. Run the discovery command: ```shell ./gateway discover \ --ai-provider gemini \ --connection-string "postgresql://neondb_owner:MY_PASSWORD@MY_HOST.neon.tech/neondb?sslmode=require" \ --prompt "Generate for me awesome readonly API" ``` 3. Enjoy the generation process: ```shell INFO 🚀 API Discovery Process INFO Step 1: Read configs INFO ✅ Step 1 completed. Done. INFO Step 2: Discover data INFO Discovered Tables: INFO - payment_dim: 3 columns, 39 rows INFO - fact_table: 9 columns, 1000000 rows INFO ✅ Step 2 completed. Done. # Additional steps and output... INFO ✅ All steps completed. Done. INFO --- Execution Statistics --- INFO Total time taken: 1m10s INFO Tokens used: 16543 (Estimated cost: $0.0616) INFO Tables processed: 6 INFO API methods created: 18 INFO Total number of columns with PII data: 2 ``` 4. Review the generated configuration in `gateway.yaml`: ```yaml api: name: Awesome Readonly API description: '' version: '1.0' database: type: postgres connection: YOUR_CONNECTION_INFO tables: - name: payment_dim columns: # Table columns endpoints: - http_method: GET http_path: /some_path mcp_method: some_method summary: Some readable summary description: 'Some description' query: SQL Query with params params: # Query parameters ``` ## Running the API ### Run locally ```shell ./gateway start --config gateway.yaml ``` ### Docker Compose ```shell docker compose -f ./example/simple/docker-compose.yml up ``` ### MCP Protocol Integration Gateway implements the MCP protocol for seamless integration with Claude and other tools. For detailed setup instructions, see our <a href="https://docs.centralmind.ai/docs/content/integration/claude-desktop/">Claude integration guide</a>. To add MCP Tool to Claude Desktop just adjust Claude's config : ```json { "mcpServers": { "gateway": { "command": "PATH_TO_GATEWAY_BINARY", "args": ["start", "--config", "PATH_TO_GATEWAY_YAML_CONFIG", "mcp-stdio"] } } } ``` ## Roadmap It is always subject to change, and the roadmap will highly depend on user feedback. At this moment, we are planning the following features: #### Database and Connectivity - 🗄️ **Extended Database Integrations** - Databricks, Redshift, S3 (Iceberg and Parquet), Oracle DB, Microsoft SQL Server, Elasticsearch - 🔑 **SSH tunneling** - ability to use jumphost or ssh bastion to tunnel connections #### Enhanced Functionality - 🔍 **Advanced Query Capabilities** - Complex filtering syntax and Aggregation functions as parameters - 🔐 **Enhanced MCP Security** - API key and OAuth authentication #### Platform Improvements - 📦 **Schema Management** - Automated schema evolution and API versioning - 🚦 **Advanced Traffic Management** - Intelligent rate limiting, Request throttling - ✍️ **Write Operations Support** - Insert, Update operations ## Database Gateway in MCP Registries - https://mcpreview.com/mcp-servers/centralmind/gateway - https://mcp.so/server/gateway/centralmind - https://smithery.ai/server/@centralmind/gateway - https://www.pulsemcp.com/servers/centralmind-database-gateway