MCP PostgreSQL 演示

一个FastMCP服务器，允许大型语言模型（LLMs）连接并与其PostgreSQL数据库交互。该项目展示了如何使用模型上下文协议（MCP）让语言模型查询和探索数据库架构和表格。

功能

• 架构探索：检索有关数据库架构的元数据
• 表检查：获取特定表的详细结构信息
• 数据库查询：对数据库执行SQL查询
• YAML格式：结果以YAML格式返回，便于LLM消费

资源

服务器公开以下MCP资源：

• database://{schema} - 获取指定架构中所有表格的信息
• database://{schema}/tables/{table} - 获取特定表的详细信息

工具

• query_database - 对数据库执行SQL查询（仅限SELECT查询）

提示

服务器包含以下预定义提示：

• prompt_schema_description - 请求某个数据库架构的描述
• prompt_table_description - 请求某个特定表格的描述
• prompt_query_database - 请求从特定表中获取数据

先决条件

• 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配置更新值

配置

应用程序使用以下环境变量进行配置：

使用

1. 首先，在src/main.py文件底部，取消注释以下内容以启用调试模式：

   # from debugpy import _input, _output
   

2. 现在你可以运行项目了。

开发

• 代码遵循标准Python命名规范和代码风格。
• 新的功能添加到main.py中，并根据需要修改现有逻辑。
• 使用Markdown格式编写文档。

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