MCP Server Db Ts

A TypeScript database query server based on the Model Context Protocol (MCP), supporting MySQL and PostgreSQL, providing table structure query and read-only SQL execution functions to ensure secure queries.

Database Developer tools #Database Query #MCP Protocol #Read-only Operation #Transaction Security Local .TypeScript

rating : 2 points

downloads : 25

update time : 2025-04-28

What is the MCP Database Server?

The MCP Database Server is a middleware service that allows AI models to securely query relational databases (MySQL/PostgreSQL) via standard protocols without direct database access. It provides table structure information and read-only query functions to ensure data access security.

How to use the MCP Database Server?

The usage process is divided into three simple steps: 1) Configure database connection information. 2) Query table structure. 3) Execute read-only SQL queries. All operations are completed through the MCP protocol to ensure standardization and security.

Applicable Scenarios

It is most suitable for scenarios where AI models need to access enterprise databases while ensuring data security, such as read-only data access requirements for data analysis assistants and intelligent report generation.

Main Features

Multi-database SupportSupports both MySQL and PostgreSQL, two mainstream relational databases

Table Structure AccessProvides database table structure information as a resource to help AI models understand the data structure

Read-only QueryEnsures that all queries are read-only through transactions to protect data security

MCP Protocol CompatibilityFully complies with the Model Context Protocol standard and seamlessly integrates with other MCP components

Advantages and Limitations

Advantages

Security Isolation: AI models do not need to directly access the database, reducing security risks.

Standardized Interface: The unified MCP protocol simplifies the integration process.

Transaction Guarantee: All queries are executed in read-only transactions to prevent data modification.

Lightweight and Efficient: Implemented in TypeScript with high operating efficiency.

Limitations

Only supports read-only operations and does not support data writing.

Currently only supports MySQL and PostgreSQL.

Requires pre-configuration of database connection information.

How to Use

Install the Service

Clone the repository and install dependencies using cnpm

Configure the Database

Copy the .env.example file and edit the database connection information

Start the Service

Build and start the MCP server

Connect and Use

Connect and use the service functions through the MCP client

Usage Examples

Get the Structure of the Products TableThe AI assistant needs to understand the structure of the products table to generate correct queries

Query Sales DataQuerying sales data is required to generate a report on last month's sales volume

Explore the DatabaseUnderstand which tables are available in the database when using it for the first time

Frequently Asked Questions

Why does my query return an empty result?

How to add support for a new database?

How many concurrent queries does the service support?

How to ensure query performance?

Related Resources

Official MCP Protocol Documentation

The complete specification document of the Model Context Protocol

GitHub Repository

Project source code and issue tracking

TypeScript Handbook

Official documentation of the TypeScript programming language

🚀 MCP Database Server (TypeScript)

A database query server based on the Model Context Protocol (MCP), implemented in TypeScript. It enables AI models to securely query relational databases such as MySQL and PostgreSQL.

🚀 Quick Start

The MCP Database Server is a powerful tool that allows AI models to interact with relational databases safely. Here's how you can get started with it.

✨ Features

Database Support: Supports both MySQL and PostgreSQL databases.
Table Structure Information: Provides table structure information as resources.
Read - only Query Execution: Supports the execution of read - only SQL queries.
Transaction Security: Uses transactions to ensure query security.

📦 Installation

Use cnpm to install the project:

git clone <repository-url>
cd mcp-server-db-ts
cnpm install

📚 Configuration

Copy the .env.example file to .env:

cp .env.example .env

Edit the .env file to set your database connection information:

# Database connection configuration
# Database type: mysql or postgres
DB_TYPE=mysql

# MySQL configuration
MYSQL_HOST=127.0.0.1
MYSQL_PORT=3306
MYSQL_USER=root
MYSQL_PASS=your_password
MYSQL_DB=your_database

# PostgreSQL configuration
PG_HOST=127.0.0.1
PG_PORT=5432
PG_USER=postgres
PG_PASS=your_password
PG_DB=your_database

# Server configuration
SERVER_NAME=mcp-server-db-ts
SERVER_VERSION=1.0.0