MCP Server Db Ts

🚀 MCP 數據庫服務器（TypeScript）

這是一個基於 Model Context Protocol (MCP) 的數據庫查詢服務器，使用 TypeScript 實現。它能讓 AI 模型安全地對 MySQL 和 PostgreSQL 等關係型數據庫進行查詢，為數據庫操作提供了安全可靠的解決方案。

🚀 快速開始

本服務器允許 AI 模型安全地查詢關係型數據庫，以下是使用前的安裝、配置、構建和運行步驟。

✨ 主要特性

• 支持 MySQL 和 PostgreSQL 數據庫，具備廣泛的數據庫兼容性。
• 提供表結構信息作為資源，方便用戶瞭解數據庫結構。
• 支持只讀 SQL 查詢執行，保障數據操作的安全性。
• 使用事務確保查詢安全性，避免數據錯誤和不一致。

📦 安裝指南

使用 cnpm 進行安裝：

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

📚 詳細文檔

配置

1. 複製 .env.example 文件為 .env：

cp .env.example .env

2. 編輯 .env 文件，設置您的數據庫連接信息：

# 數據庫連接配置
# 數據庫類型: mysql 或 postgres
DB_TYPE=mysql

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

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

# 服務器配置
SERVER_NAME=mcp-server-db-ts
SERVER_VERSION=1.0.0

構建

cnpm run build

運行

cnpm start

開發模式

cnpm run dev

支持的 MCP 功能

資源

• list_resources：列出數據庫中的所有表。
• read_resource：獲取指定表的結構信息。

工具

• db_query：執行只讀 SQL 查詢。

💻 使用示例

基礎用法

以下是幾種常見操作的使用示例：

1. 列出所有表：
   • MCP 請求：list_resources
   • 響應：以 URI 形式返回所有表的列表。
2. 獲取表結構：
   • MCP 請求：read_resource 使用特定表的 URI
   • 響應：返回表的列信息。
3. 執行查詢：
   • MCP 請求：call_tool 使用 db_query 工具和 SQL 查詢
   • 響應：返回查詢結果。

📄 許可證

本項目採用 MIT 許可證。