MCP Server Db Ts

🚀 MCP データベースサーバー（TypeScript）

これは、Model Context Protocol (MCP) に基づくデータベースクエリサーバーで、TypeScript で実装されています。このサーバーは、AI モデルが MySQL や PostgreSQL などのリレーショナルデータベースを安全にクエリできるようにします。

✨ 主な機能

• MySQL と PostgreSQL データベースをサポート
• 表構造情報をリソースとして提供
• 読み取り専用の SQL クエリの実行をサポート
• トランザクションを使用してクエリの安全性を確保

📦 インストール

cnpm を使用してインストールします。

git clone <repository-url>
cd mcp-server-db-ts
cnpm install

📚 ドキュメント

設定

1. .env.example ファイルを .env にコピーします。

cp .env.example .env

2. .env ファイルを編集して、データベース接続情報を設定します。

# データベース接続設定
# データベースタイプ: mysql または postgres
DB_TYPE=mysql

# MySQL 設定
MYSQL_HOST=127.0.0.1
MYSQL_PORT=3306
MYSQL_USER=root
MYSQL_PASS=your_password
MYSQL_DB=your_database

# PostgreSQL 設定
PG_HOST=127.0.0.1
PG_PORT=5432
PG_USER=postgres
PG_PASS=your_password
PG_DB=your_database

# サーバー設定
SERVER_NAME=mcp-server-db-ts
SERVER_VERSION=1.0.0

ビルド

cnpm run build

実行

cnpm start

開発モード

cnpm run dev

サポートされる MCP 機能

リソース

• list_resources: データベース内のすべての表をリストする
• read_resource: 指定された表の構造情報を取得する

ツール

• db_query: 読み取り専用の SQL クエリを実行する

💻 使用例

基本的な使用法

1. すべての表をリストする

   • MCP リクエスト: list_resources
   • レスポンス: URI 形式ですべての表のリストを返す

2. 表構造を取得する

   • MCP リクエスト: 特定の表の URI を使用した read_resource
   • レスポンス: 表の列情報を返す

3. クエリを実行する

   • MCP リクエスト: call_tool を使用して db_query ツールと SQL クエリを指定
   • レスポンス: クエリ結果を返す

📄 ライセンス

MIT