Sql MCP Server

🚀 クイックMCP SQL Server

対話型AIインターフェースを通じてSQLデータベースとのインタラクションを提供するクイックMCPサーバーです。このサーバーにより、ユーザーは自然言語でSQLデータベースとやり取りすることができます。

🚀 クイックスタート

このプロジェクトでは、対話型AIインターフェースを介してMicrosoft SQL Serverの操作を公開するサーバーを作成します。FastMCPフレームワークを使用して、SQLデータのクエリと操作を行うツールを提供し、ユーザーが自然言語でデータベースとやり取りできるようにします。

✨ 主な機能

• SQLクエリを実行し、結果を表示する
• データベース内の利用可能なテーブルを一覧表示する
• テーブル構造と列情報を取得する
• INSERT、UPDATE、DELETEなどの非クエリ操作を実行する
• システムにインストールされているODBCドライバーを一覧表示する
• データベース情報とサーバー詳細を表示する

📦 インストール

前提条件

• Python 3.7以上
• pyodbc
• asyncio
• FastMCPフレームワーク
• Microsoft SQL Server
• ODBC Driver 17 for SQL Server

手順

1. Pythonの依存関係をインストールします。

pip install pyodbc asyncio fastmcp

2. Microsoft SQL ServerとODBC Driver 17 for SQL Serverがインストールされていることを確認します。
3. スクリプト内で接続パラメータを設定します。

# 接続パラメータ
SERVER = "server\\instance"  # ご自身のSQL Serverインスタンスに変更してください
DATABASE = "db_name"              # ご自身のデータベース名に変更してください

💻 使用例

基本的な使用法

サーバーを起動します。

python mcp_sql_server.py

サーバーは初期化され、指定されたSQL Serverデータベースに接続します。

高度な使用法

以下は、利用可能なツールの説明です。

query_sql

SQLクエリを実行し、結果を返します。

query_sql(query: str = None) -> str

• クエリが提供されない場合、デフォルトで SELECT * FROM [dbo].[Table_1] が実行されます。
• 結果はフォーマットされた文字列として返されます。

list_tables

データベース内のすべてのテーブルを一覧表示します。

list_tables() -> str

• テーブル名のリストが文字列として返されます。

describe_table

特定のテーブルの構造を取得します。

describe_table(table_name: str) -> str

• table_name: 説明するテーブルの名前
• 列名とデータ型を含む情報が返されます。

execute_nonquery

INSERT、UPDATE、DELETEまたはその他の非クエリSQL文を実行します。

execute_nonquery(sql: str) -> str

• sql: 実行するSQL文
• 操作結果（影響を受けた行数を含む）が返されます。
• トランザクションは自動的に処理されます（コミット/ロールバック）。

list_odbc_drivers

システムにインストールされているすべてのODBCドライバーを一覧表示します。

list_odbc_drivers() -> str

• インストールされているODBCドライバーのカンマ区切りのリストが返されます。

database_info

接続されているデータベースの基本情報を取得します。

database_info() -> str

• データベースのバージョンと構成情報が返されます。

🔧 技術詳細

サーバーは非同期プログラミングライブラリのasyncioを使用し、FastMCPフレームワークと組み合わせて効率的な通信を実現しています。データクエリはpyodbcを通じて実行され、データベースとの接続プールを確立することでパフォーマンスを最適化しています。

エラー処理

すべてのデータベース操作はtry-exceptブロックでラップされており、例外をキャッチしてユーザーに分かりやすいエラーメッセージを返します。

カスタマイズ

機能を拡張するには、新しいツールをtools.pyファイルに追加し、main.pyのコマンド辞書に登録します。

セキュリティに関する注意事項

• データベース接続はSSLで暗号化されています。
• デフォルトではリモートアクセスは無効になっています。
• 認証プラグインの拡張をサポートしています。

トラブルシューティング

データベースに接続できない場合

以下の点を確認してください。

1. データベースサービスが実行されていることを確認します。
2. ファイアウォール設定が接続を許可していることを確認します。
3. 提供された資格情報が正しいことを確認します。

依存関係のインストールに失敗した場合

Python 3.7以上を使用していることを確認し、インストール中にネットワーク接続が維持されていることを確認してください。

📄 ライセンス

このプロジェクトはMITライセンスに基づいています。詳細については、LICENSEファイルを参照してください。

お問い合わせ

フィードバックや技術サポートが必要な場合は、プロジェクトのGitHubリポジトリにアクセスするか、メンテナーに連絡してください。