MCP Server Postgres

🚀 PostgreSQL 服務器 MCP 的數據庫功能描述

本項目提供了一系列與 PostgreSQL 數據庫交互的功能，涵蓋數據庫連接管理、輔助函數以及主要的數據庫操作功能，同時還暴露了一些 API 供外部調用。

✨ 主要特性

• 提供數據庫連接類，方便管理與 PostgreSQL 數據庫的連接。
• 包含輔助函數，用於特殊數據類型的 JSON 序列化和單例模式獲取數據庫連接。
• 具備多個主要數據庫功能函數，可列出表、獲取表信息、查詢表數據和執行自定義 SQL 查詢。
• 暴露了 MCP 工具 API，方便外部調用數據庫操作功能。

📦 安裝指南

原文檔未提供安裝步驟，故跳過此章節。

💻 使用示例

基礎用法

# 導入必要的類和函數
from your_module import DatabaseConnection, get_db, list_tables

# 獲取數據庫連接
db = get_db()

# 列出數據庫中的所有表
tables = list_tables(db)
print(tables)

高級用法

# 導入必要的類和函數
from your_module import DatabaseConnection, execute_query

# 創建數據庫連接
db = DatabaseConnection()

# 執行自定義 SQL 查詢
query = "SELECT * FROM your_table WHERE column = %s"
params = ("value",)
result = execute_query(db, query, params)
print(result)

📚 詳細文檔

數據庫連接類

DatabaseConnection

• 目的：管理與 PostgreSQL 數據庫的連接。
• 構造函數參數：
  • host：數據庫主機地址，字符串類型，默認值為 "localhost"。
  • database：數據庫名稱，字符串類型，默認值為 "postgres"。
  • user：數據庫用戶名，字符串類型，默認值為 "postgres"。
  • password：數據庫密碼，字符串類型，默認值為 "codenexus"。
• 方法：
  • close()：關閉到數據庫的連接。

輔助函數

json_serializer(obj: Any) -> Any

• 目的：對特殊數據類型進行 JSON 序列化。
• 處理：
  • datetime/date 對象 → ISO 格式字符串。
  • Decimal 數字 → 浮點數。

get_db() -> DatabaseConnection

• 目的：使用單例模式獲取數據庫連接。
• 返回：全局數據庫連接實例或 None（如果連接失敗）。

主要數據庫功能函數

list_tables(db: DatabaseConnection) -> str

• 目的：列出數據庫中的所有表。
• 返回：格式化字符串，包含表名列表。

get_table_info(db: DatabaseConnection, table: str) -> str

• 目的：獲取特定表的詳細信息。
• 返回：格式化字符串，包含：
  • 列信息（名稱、類型、長度、是否為空、默認值）。
  • 主鍵信息。
  • 行總數。

query_table(db: DatabaseConnection, table: str, limit: Optional[int] = 5) -> str

• 目的：查詢表中的數據。
• 參數：
  • table：要查詢的表名。
  • limit：最大返回行數，默認值為 5。
• 返回：格式化字符串，包含查詢結果。

execute_query(db: DatabaseConnection, query: str, params: Optional[tuple] = None) -> str

• 目的：執行自定義 SQL 查詢。
• 參數：
  • query：要執行的 SQL 查詢語句。
  • params：查詢參數（可選）。
• 返回：查詢結果或受影響行數。

MCP 工具（暴露的 API）

@mcp.tool() list_tables_tool(args: dict) -> str

• 目的：列表接口用於列出表格。
• 返回：可用表格列表或錯誤信息。

@mcp.tool() get_table_info_tool(args: dict) -> str

• 目的：表格信息接口用於獲取詳細信息。
• 必需參數：
  • table：要檢查的表名。
• 返回：表格的詳細信息或錯誤信息。

@mcp.tool() query_table_tool(args: dict) -> str

• 目的：查詢表格數據的接口。
• 必需參數：
  • table：要查詢的表名。
• 可選參數：
  • limit：最大返回行數，默認值為 5。
• 返回：查詢結果或錯誤信息。

@mcp.tool() execute_query_tool(args: dict) -> str

• 目的：執行自定義 SQL 查詢的接口。
• 必需參數：
  • query：要執行的查詢語句。
• 可選參數：
  • params：查詢參數。
• 返回：查詢結果或錯誤信息。

🔧 技術細節

原文檔未提供具體的技術實現細節，故跳過此章節。

📄 許可證

原文檔未提供許可證信息，故跳過此章節。