Pg MCP Server

🚀 PG_MCPサーバー

PostgreSQL + PostGISをサポートするカスタム実装

🚀 クイックスタート

このPG_MCPサーバーは、汎用的なPostgreSQL MCPサーバーです。MCP部分は[go - mcp](https://github.com/ThinkInAIXYZ/go - mcp)を使用して実装され、StdioとSSE伝送をサポートしています。

日本語ドキュメント

PostGISとPgVectorに関する記述は、別のオープンソースプロジェクトhttps://github.com/stuzero/pg - mcp - server から引用しています🙏🙏paginator
このようなコンテキストを提供するアイデアは新鮮です。

⚠️ 重要提示

データベースにはSQLインジェクションを防止するためにロールを定義する必要があります。publicスキーマに対するSELECT権限を付与して、機密データの漏洩を防いでください。

⚠️ 重要提示

新しいロールにtempスキーマ内のすべてのテーブルに対するSELECT、INSERT、UPDATE、DELETE権限を付与して、データの分離を確保してください。

✨ 主な機能

ローカルで大規模言語モデルをデプロイする際、コンテキスト管理は効率的である必要があります。各呼び出し時にデータベーススキーマを読み取ると、時間と貴重なコンテキストトークンが消費されます。このプロジェクトでは前処理方法を採用しています。データベースからテーブル構造を取得し、LLMに説明的な情報を提供することをネイティブにサポートしています。

• ツールの説明と入力モードを利用して、スキーマ情報を暗黙的または明示的に伝えます。
• 初期化時にMCPリソースを利用して、テーブル名、列、制約、外部キー、インデックス、ジオメトリタイプ、EPSGコードを読み取り、大規模モデルの基礎理解を構築します。

📦 インストール

main.goでは以下のように設定できます。

// ここでデータベースとのやり取りの接続文字列が設定できます
schemaLoadConnID, err := dbService.RegisterConnection(tempCtx, "postgres://mcp_user:mcp123456@192.168.2.19:5432/postgres")

形式はpostgres://user:pass@host:port/dbです。
または.envファイルで設定することもでき、SCHEMA_LOAD_DB_URL変数を設定するだけです。 ここで、RegisterConnectionはサーバーにデータベーステーブル情報をキャッシュするための初期接続文字列を与えます。
🏁 サーバー用に専用のロールを作成することをおすすめします。以下はSQL文です。

-- 新しいロールを作成し、パスワードを設定する
CREATE ROLE mcp_user WITH LOGIN PASSWORD 'mcp123456';

-- mcp_userの基本権限を設定する
GRANT CONNECT ON DATABASE postgres TO mcp_user;
GRANT USAGE ON SCHEMA public TO mcp_user;

-- publicスキーマ内のすべての既存テーブルに対するSELECT権限を付与する
GRANT SELECT ON ALL TABLES IN SCHEMA public TO mcp_user;

-- publicスキーマ内の新しいテーブルに対するSELECT権限をmcp_userに自動的に付与する
ALTER DEFAULT PRIVILEGES IN SCHEMA public
   GRANT SELECT ON TABLES TO mcp_user;

-- tempスキーマを作成する
CREATE SCHEMA temp;

-- tempスキーマに対するすべての権限をmcp_userに付与する
GRANT USAGE, CREATE ON SCHEMA temp TO mcp_user;
GRANT SELECT, INSERT, UPDATE, DELETE ON ALL TABLES IN SCHEMA temp TO mcp_user;

-- tempスキーマ内の新しいテーブルに対するSELECT、INSERT、UPDATE、DELETE権限をmcp_userに自動的に付与する
ALTER DEFAULT PRIVILEGES IN SCHEMA temp
   GRANT SELECT, INSERT, UPDATE, DELETE ON TABLES TO mcp_user;

💻 使用例

基本的な使用法

Dockerを使用して実行する場合

1. Dockerがインストールされていることを確認してください。
2. プロジェクトディレクトリで以下のコマンドを実行します。

docker-compose up --build

これにより、サービスが構築され、起動します。

直接実行する場合

すべての依存関係がインストールされていることを確認してください。ターミナルでプロジェクトのルートディレクトリに移動し、以下を実行します。

go run main.go

📚 ドキュメント

拡張サポート

• PostGIS: 実装済み
• PgVector: 実装済み
• PgRouting: 開発中

今後の予定

• 温表管理メカニズム
  • テーブル構造のキャッシュを実装する
  • テーブル構造の変更検出を追加する
  • 無効化ポリシーを策定する
• 単体テスト
  • テーブル構造の読み取りと解析の単体テスト
  • SQLインジェクションとXSS対策のテスト