MCP Server Postgres

🚀 PostgreSQL サーバー MCP のデータベース機能説明

このドキュメントでは、PostgreSQL サーバー MCP のデータベース機能について詳しく説明します。このシステムは、データベース接続の管理、JSON シリアライズ、データベース操作などの機能を提供します。

✨ 主な機能

データベース接続管理

• DatabaseConnection クラスを使用して、PostgreSQL データベースへの接続を管理します。

特殊データ型の JSON シリアライズ

• json_serializer 関数を使用して、datetime/date オブジェクトや Decimal 数字を JSON 形式にシリアライズします。

データベース操作

• テーブルの一覧表示、特定テーブルの詳細情報取得、データのクエリ、カスタム SQL クエリの実行などの操作を行うことができます。

📦 インストール

原ドキュメントにインストール手順に関する内容がありません。

💻 使用例

基本的な使用法

# データベース接続の取得
from your_module import get_db
db = get_db()

# テーブルの一覧表示
from your_module import list_tables
table_list = list_tables(db)
print(table_list)

高度な使用法

# カスタム SQL クエリの実行
from your_module import execute_query
query = "SELECT * FROM your_table WHERE column = %s"
params = ('value',)
result = execute_query(db, query, params)
print(result)

📚 ドキュメント

データベース接続クラス

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 数字 → 浮動小数点数

get_db() -> DatabaseConnection

• 目的: シングルトンパターンを使用してデータベース接続を取得します。
• 戻り値: グローバルなデータベース接続インスタンスまたは None (接続に失敗した場合)

主要なデータベース機能関数

list_tables(db: DatabaseConnection) -> str

• 目的: データベース内のすべてのテーブルを一覧表示します。
• 戻り値: テーブル名のリストを含むフォーマットされた文字列

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

• 目的: 特定のテーブルの詳細情報を取得します。
• 戻り値: 以下の情報を含むフォーマットされた文字列:
  • 列情報 (名前、型、長さ、NULL 許容、デフォルト値)
  • 主キー情報
  • 行数の合計

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: クエリパラメータ
• 戻り値: クエリ結果またはエラーメッセージ

🔧 技術詳細

原ドキュメントに技術的な実装詳細に関する内容がありません。

📄 ライセンス

原ドキュメントにライセンス情報に関する内容がありません。