Simple Psql MCP

🚀 シンプルなPostgreSQL MCPサーバー

このテンプレートプロジェクトは、独自のMCPサーバーを構築したい人を支援することを目的としています。コードは非常にシンプルで、MCPのドキュメントも付属しているため、すぐに始めることができます。

🚀 クイックスタート

このPostgreSQL MCPサーバーは、LLMと外部ツールやデータをやり取りするための標準的な方法であるMCPを実装しています。以下の手順でサーバーをセットアップし、使用することができます。

✨ 主な機能

ツール

• execute_query：データベースに対してSQLクエリを実行します。
• test_connection：データベース接続が正常に機能していることを検証します。

リソース

• db://tables：スキーマ内のすべてのテーブルをリストします。
• db://tables/{table_name}：特定のテーブルのスキーマ情報を提供します。
• db://：LLMを使用して直接データベースをクエリできるようにする、事前にロードされたプロンプトテンプレートです。

プロンプト

• 事前にロードされたプロンプトテンプレートを使用して、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. pyproject.toml に新しいMCPを追加します。

[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ドキュメントが含まれています。
• こちら の方法に基づいています。

🔧 技術詳細

什么是MCP？

簡単に言えば、AIプラグインを作成する方法です

モデルコンテキストプロトコル（MCP）は、LLMが外部ツールやデータとやり取りするための標準的な方法です。主な要素は以下の通りです。

• ツール：LLMがコマンドを実行できるようにします（例：データベースクエリの実行）。
• リソース：会話に追加できるデータです（例：プロンプトにファイルを添付する）。
• プロンプト：一貫したLLM命令テンプレートです。

⚠️ 重要提示

このプロジェクトは実験的なもので、開発者が独自のMCPサーバーを構築できるようにすることを目的としています。私はできる限りサーバーがすぐにクラッシュしないようにしていますが、SQLインジェクションが容易に行えるため、注意して使用してください。簡単に言えば、スタートアップの創業者でなく、有料顧客がいない限り、本番環境で使用しないでください。

📄 ライセンス

MIT