Skip to main content

db-semantic-mcp

A multi-backend MCP server for AI coding agents — supports both PostgreSQL and SQL Server.

Exposes your database schema — table names, column types, comments, and sample data — as MCP tools. Includes semantic search powered by any OpenAI-compatible LLM, enriched by a user-authored semantic layer document.

No SQL execution. Read-only. No vector database required.

Backends

Backend Scheme Driver Required Extras
PostgreSQL postgresql://... asyncpg (built-in)
SQL Server sqlserver://... pymssql [sqlserver]

The backend is auto-detected from DATABASE_URL. Everything else works the same.

Features

  • list_tables — discover all tables with comments
  • describe_table — inspect column names, types, nullability, and comments
  • sample_data — fetch example rows from any table
  • search_schema — semantic keyword search across tables and columns using LLM

Install

# PostgreSQL only
pip install db-semantic-mcp

# With SQL Server support
pip install "db-semantic-mcp[sqlserver]"

Requires Python 3.11+.

Quick Start

# PostgreSQL
export DATABASE_URL="postgresql://user:pass@localhost:5432/mydb"

# SQL Server (Kingdee ERP or any MSSQL instance)
export DATABASE_URL="sqlserver://user:pass@host:1433?database=mydb&encrypt=disable"

export LLM_API_KEY="sk-..."          # required only for search_schema
pg-semantic-mcp

Configuration

Variable Required Default Description
DATABASE_URL yes PostgreSQL or SQL Server connection string
SEMANTIC_FILE no Path to your semantic layer markdown
LLM_BASE_URL no https://api.openai.com/v1 OpenAI-compatible endpoint
LLM_API_KEY no Required for search_schema
LLM_MODEL no gpt-4o-mini LLM model name
CACHE_REFRESH_MINUTES no 30 Background cache refresh interval
CACHE_SCHEMAS no all Comma-separated schema names to cache
CACHE_TABLE_PREFIX no Comma-separated table name prefixes to cache
SAMPLE_DATA_LIMIT no 5 Default row count for sample_data

You can also use a .env file in the working directory.

Register with OpenCode

Add to your opencode.jsonc:

{
  "mcp": {
    "pg-data": {
      "type": "local",
      "command": "pg-semantic-mcp",
      "environment": {
        "DATABASE_URL": "postgresql://user:pass@host:5432/dbname",
        "SEMANTIC_FILE": "/path/to/SCHEMA.md",
        "LLM_API_KEY": "sk-..."
      }
    }
  }
}

Same config format works for Claude Code, Cursor, and any MCP-compatible agent.

Semantic Layer

Create a SCHEMA.md file describing your database — naming conventions, business term mappings, design decisions. See SCHEMA.md.example for a template.

This document is loaded at startup and included in the search_schema LLM prompt. It is the main way to teach the agent about your specific domain.

Compatible LLMs

search_schema calls any OpenAI-compatible endpoint:

  • OpenAI (gpt-4o-mini, gpt-4o, …)
  • DeepSeek (deepseek-v4, set LLM_BASE_URL=https://api.deepseek.com/v1)
  • Anthropic via proxy
  • Local models via Ollama or LM Studio

License

MIT

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

db_semantic_mcp-0.1.0.tar.gz (14.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

db_semantic_mcp-0.1.0-py3-none-any.whl (15.8 kB view details)

Uploaded Python 3

File details

Details for the file db_semantic_mcp-0.1.0.tar.gz.

File metadata

  • Download URL: db_semantic_mcp-0.1.0.tar.gz
  • Upload date:
  • Size: 14.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.11

File hashes

Hashes for db_semantic_mcp-0.1.0.tar.gz
Algorithm Hash digest
SHA256 88889685ef2a7e268c8cb89247aa19f1ccd7a524ed3f58230a8343fa9883ae77
MD5 5d0b4306f5b2b314d99a4d028e66dba0
BLAKE2b-256 7b442862b2f371da0eaba8e4d914bd2ab84d6561d1c79542fb0e9322e22bae4f

See more details on using hashes here.

File details

Details for the file db_semantic_mcp-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for db_semantic_mcp-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 101f98a7fd9f9d6add72d1683f49dc386ed15b68e5c704f4e84f681b813a7a7c
MD5 6a30a70430cd96280a8721730e20e2ab
BLAKE2b-256 157bff45ad417fb091ca550db8f41656bad468617f354d137a9aee2b77c5c7a9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page