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注入。除非您是初創公司的創始人並且沒有付費客戶，否則不要在生產環境中使用。