MCP Postgresql Demo

🚀 MCP PostgreSQL 演示

本項目是一個 FastMCP 服務器，可讓大型語言模型（LLMs）連接並與 PostgreSQL 數據庫進行交互。它展示瞭如何利用模型上下文協議（MCP），使語言模型能夠查詢和探索數據庫架構與表格。

✨ 主要特性

• 架構探索：可檢索有關數據庫架構的元數據。
• 表檢查：能獲取特定表的詳細結構信息。
• 數據庫查詢：可對數據庫執行 SQL 查詢。
• YAML 格式：結果以 YAML 格式返回，方便 LLM 消費。

📦 安裝指南

先決條件

• Python 3.12 或更高版本
• PostgreSQL 數據庫
• UV 包管理器（推薦）

安裝步驟

1. 克隆倉庫：

git clone <repository-url>
cd mcp-demo

2. 創建虛擬環境：

python -m venv .venv
source .venv/bin/activate  # 在 Windows 上：.venv\Scripts\activate

3. 安裝 UV（如果尚未安裝）：

pip install uv

4. 使用 UV 安裝依賴：

uv sync

5. 配置環境變量：

• 複製 .env.example 到 .env
• 根據 PostgreSQL 配置更新值

📚 詳細文檔

資源

服務器公開以下 MCP 資源：

• database://{schema} - 獲取指定架構中所有表格的信息
• database://{schema}/tables/{table} - 獲取特定表的詳細信息

工具

• query_database - 對數據庫執行 SQL 查詢（僅限 SELECT 查詢）

提示

服務器包含以下預定義提示：

• prompt_schema_description - 請求某個數據庫架構的描述
• prompt_table_description - 請求某個特定表格的描述
• prompt_query_database - 請求從特定表中獲取數據

配置

應用程序使用以下環境變量進行配置：

💻 使用示例

基礎用法

1. 首先，在 src/main.py 文件底部，取消註釋以下內容以啟用調試模式：

# from debugpy import _input, _output

2. 現在你可以運行項目了。

高級用法

如果你想使用 Docker 運行項目，可以按照以下步驟操作：

1. 將項目文件夾壓縮為 .tar.gz 文件：

tar -czvf mcp-demo.tar.gz .

2. 使用以下 Dockerfile 構建鏡像：

# 基礎鏡像
FROM python:3.8-slim

# 作者信息
LABEL maintainer="Ricardo Santos <ricardo.santos.diaz@gmail.com>"

# 安裝依賴
EXPOSE 5000
RUN mkdir -p /app
WORKDIR /app
COPY . .
RUN pip install --no-cache-dir -r requirements.txt

# 運行命令
CMD ["python", "main.py"]

3. 構建鏡像並運行：

docker build -t mcp-demo:latest .
docker run -p 5000:5000 --name mcp_demo mcp-demo:latest

📄 許可證

[在此處添加你的許可信息]

貢獻者

• Ricardo Santos ricardo.santos.diaz@gmail.com