simple-psql-mcp

🚀 简单的 PostgreSQL MCP 服务器

本项目是一个模板项目，旨在助力想要构建自己MCP服务器的开发者。它设计得简单易懂、易于适配，代码直观明了，还附有MCP文档，助您快速上手。

🚀 快速开始

本项目是一个用于构建MCP服务器的模板，您可以按照以下步骤快速开始使用：

1. 克隆此仓库。
2. 创建并激活虚拟环境（推荐）。
3. 运行以下命令安装依赖项：

pip install poetry
poetry install

✨ 主要特性

此PostgreSQL MCP服务器具备以下特性：

1. 工具
   • execute_query：可对数据库运行SQL查询。
   • test_connection：用于验证数据库连接是否正常工作。
2. 资源
   • db://tables：列出模式中的所有表。
   • db://tables/{table_name}：获取特定表的架构信息。
   • db://：预加载的提示模板，允许用户直接使用LLM查询数据库。
3. 提示：预加载的提示模板，使用户能够直接利用LLM对数据库进行查询。

📦 安装指南

1. 克隆此仓库。
2. 创建并激活虚拟环境（推荐）。
3. 运行以下命令安装依赖项：

pip install poetry
poetry install

💻 使用示例

基础用法

1. 创建示例数据库

要创建一个包含用户和地址表的示例PostgreSQL数据库，运行以下脚本：

npx @modelcontextprotocol/inspector uv --directory . run postgres -e DSN=postgresql://postgres:postgres@localhost:5432/user_database -e SCHEMA=public

2. 运行Inspector界面

要通过Inspector访问MCP服务器，运行以下命令：

npx @modelcontextprotocol/inspector uv --directory . run postgres

然后在浏览器中打开 http://localhost:3000/postgres。

高级用法

扩展项目

要扩展此项目并添加新的MCP服务器，可按以下步骤操作：

1. 在 /src 目录下创建一个新的子目录（例如 /src/my-new-mcp）。
2. 根据PostgreSQL示例实现您的新MCP服务器。
3. 将新的MCP添加到 pyproject.toml 中：

[project.scripts]
postgres = "src.postgres:main"
my-new-mcp = "src.my-new-mcp:main"

然后，您可以运行新的MCP：

npx @modelcontextprotocol/inspector uv --directory . run my-new-mcp

📚 详细文档

• 本项目包含有关LLM开发的轻松MCP文档。
• 文档基于 此处 的方法。

📄 许可证

本项目采用MIT许可证。

⚠️ 重要提示

这是一个实验性项目，旨在赋予开发者构建自己的MCP服务器的能力。虽尽量确保其稳定性，但非常容易运行SQL注入。除非您是初创公司的创始人并且没有付费客户，否则不要在生产环境中使用。