MCP PostgreSQL 服务器功能概述

数据库连接类

DatabaseConnection

• 目的: 管理 PostgreSQL 数据库的连接
• 构造函数参数:
  • host: str (默认: "localhost")
  • database: str (默认: "postgres")
  • user: str (默认: "postgres")
  • password: str (默认: "codenexus")
• 方法:
  • close(): 关闭数据库连接

辅助函数

json_serializer(obj: Any) -> Any

• 目的: 将特殊数据类型序列化为 JSON
• 处理:
  • datetime/date 对象 → ISO 格式
  • Decimal 数字 → float

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

• 目的: 列出表的 API 入口点
• 返回: 可用表列表或错误消息

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

• 目的: 表信息的 API 入口点
• 必需参数:
  • table: 要检查的表名
• 返回: 表的详细信息或错误消息

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

• 目的: 查询表的 API 入口点
• 必需参数:
  • table: 要查询的表名
• 可选参数:
  • limit: 要返回的最大行数（默认: 5）
• 返回: 查询结果或错误消息

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

• 目的: 自定义 SQL 查询的 API 入口点
• 必需参数:
  • query: 要执行的 SQL 查询
• 可选参数:
  • params: 查询的参数
• 返回: 查询结果或错误消息