Openlinksoftware MCP Sqlalchemy Server

🚀 SQLAlchemy を用いた MCP サーバー ODBC

この軽量な MCP（モデルコンテキストプロトコル）サーバーは、ODBC 用に設計されており、FastAPI、pyodbc、SQLAlchemy を使用して構築されています。このサーバーは、Virtuoso データベース管理システム（DBMS）や、SQL Alchemy プロバイダーを実装した他のバックエンドデータベースと互換性があります。

🚀 クイックスタート

この MCP サーバーは、FastAPI、pyodbc、SQLAlchemy を用いて構築された軽量なサーバーで、Virtuoso などのデータベースと互換性があります。以下に、サーバーのセットアップと使用方法を説明します。

✨ 主な機能

• スキーマの取得：データベース内のすべてのスキーマ名を取得してリスト化します。
• テーブルの取得：特定のスキーマまたはすべてのスキーマのテーブル情報を取得します。
• テーブルの説明：テーブル構造の詳細な説明を生成します。内容は以下の通りです。
  • 列名とデータ型
  • ヌル許容属性
  • 主キーと外部キー
• テーブルの検索：名前の部分文字列でテーブルをフィルタリングして取得します。
• ストアドプロシージャの実行：Virtuoso では、ストアドプロシージャを実行して結果を取得します。
• クエリの実行：
  • JSONL 結果形式：構造化されたレスポンスに最適化されています。
  • Markdown テーブル形式：レポートや可視化に適しています。

📦 インストール

前提条件

1. uv のインストール：

   pip install uv
   

   または Homebrew を使用する場合は：

   brew install uv
   

2. unixODBC ランタイム環境のチェック：

   1. インストール設定（例：INI ファイルの場所）を確認するには、odbcinst -j を実行します。
   2. 使用可能なデータソース名をリストするには、odbcinst -q -s を実行します。

3. ODBC データソース名の設定：ODBC データソース名 (~/.odbc.ini) を構成して、ターゲットデータベースに一致させます。Virtuoso の例：

   [odbc]
   Driver = Virtuoso ODBC Driver
   ServerName = localhost:8889
   DatabaseName = db_name
   Username = user_name
   Password = user_password
   

4. SQLAlchemy と Python ODBC ライブラリのインストール：

   pip install sqlalchemy pyodbc
   

インストール手順

1. コードリポジトリをローカルディレクトリにクローンします：

   git clone https://github.com/your-username/mcp-server.git
   cd mcp-server
   

2. config.py ファイルを更新して、データベース設定に一致させます。

3. サーバーを起動します：

   uvicorn main:app --reload
   

📚 ドキュメント

設定

1. 環境変数の更新：ルートディレクトリで .env ファイルを作成または編集し、以下の内容を追加します：

   DATABASE_URL=odbc://username:password@localhost:8889/db_name
   

2. Claude Desktop ユーザーの設定例：

   npx @modelcontextprotocol/core --directory . run mcp-server
   

データベース接続 URL 形式

以下の表に、サポートされているデータベースと対応する ODBC 接続文字列形式を示します。

ツール

• virtuosoSupportAI：Virtuoso サポートアシスタント/エージェントと対話するためのツールで、Virtuoso 特有の機能で、大規模言語モデル（LLM）とのやり取りに使用されます。

🔧 トラブルシューティング

トラブルシューティングを容易にするために：

1. MCP インスペクターをインストールします：

   npm install -g @modelcontextprotocol/inspector
   

2. インスペクターを起動します：

   npx @modelcontextprotocol/inspector uv --directory /path/to/mcp-server run mcp-server
   

提供された URL にアクセスして、サーバーとのやり取りに関する問題を解決します。