简单的 PostgreSQL MCP 服务器

这是一个模板项目，旨在帮助那些希望构建自己的MCP服务器的人。我设计它是为了简单易懂和易于适应——代码非常直接，并附有MCP文档，因此您可以快速上手。

什么是MCP？

简而言之：它是编写AI插件的一种方式

模型上下文协议（MCP）是LLM与外部工具和数据交互的标准方法。 nutshell中的核心：

• 工具允许LLM执行命令（例如运行数据库查询）
• 资源是可以附加到对话的数据（例如将文件附加到提示中）
• 提示是一致的LLM指令模板

功能

此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文档
• 基于 此处 的方法

安全注意事项

这是一个实验性项目，旨在赋予开发者构建自己的MCP服务器的能力。我尽量确保它不会立即崩溃，但请小心——非常容易运行SQL注入。简而言之：除非您是初创公司的创始人并且没有付费客户，否则不要在生产环境中使用。

许可证

MIT