Mysql MCP Server L7j

🚀 MySQL MCP サーバー

このサーバーは、MySQLデータベースへの読み取り専用アクセスを提供するモデルコンテキストプロトコル（Model Context Protocol）サーバーです。大規模言語モデル（LLM）がデータベーススキーマを確認し、読み取り専用クエリを実行できるようにします。

🚀 クイックスタート

このサーバーを利用することで、大規模言語モデル（LLM）がMySQLデータベースのスキーマを確認し、読み取り専用クエリを実行できます。以下に、サーバーの認証、コンポーネント、インストール、Cursorとの連携方法、セキュリティ上のベストプラクティス、ライセンスについて説明します。

✨ 主な機能

• 大規模言語モデル（LLM）に対して、MySQLデータベースの読み取り専用アクセスを提供します。
• 各テーブルのJSONスキーマ情報を提供し、列名やデータ型を含みます。
• 提供されたクレデンシャルを使用して自動的に認証を処理します。

🔐 認証

このサーバーは、データベースURLを通じてMySQL認証をサポートしています。URLの形式は以下の通りです。

mysql://ユーザー名:パスワード@ホスト:ポート/データベース

例:

• データベース: mysql://user:pass@localhost:3306/mydb

⚠️ 重要提示

常にクレデンシャルを安全に保管し、設定を公開しないでください。

📦 インストール

1. リポジトリをクローンします。

git clone https://github.com/yourusername/mysql-mcp-server.git
cd mysql-mcp-server

2. 依存関係を準備してインストールします。

npm run prepare
npm install

3. グローバルリンクを作成します。

npm link

これで、ターミナルのどこからでもmysql-mcp-serverコマンドを使用できます。

mysql-mcp-server mysql://user:password@localhost:3306/mydb

💻 使用例

基本的な使用法

サーバーの起動

mysql-mcp-server mysql://user:password@localhost:3306/mydb

高度な使用法

Cursorでの使用

CursorでMCPを設定する

1. Cursorの設定を開きます。
   • 左下の歯車アイコン（⚙️）をクリックするか、macOSではShift + Cmd + Jを押します。
2. MCPサーバーを設定します。
   • 左側のサイドバーの「MCP」をクリックします。
   • 「グローバルMCPサーバーを追加」をクリックします。
   • 以下の設定を追加します。

{
  "mcpServers": {
    "mysql": {
      "command": "mysql-mcp-server",
      "args": ["mysql://user:password@localhost:3306/mydb"]
    }
  }
}

3. 設定を保存します。
   • 「保存」をクリックするか、Cmd + Sを押します。
   • Cursorを再起動して変更を反映させます。

Cursorでの使用方法

Cursorのスマートチャットウィンドウを開き、データベースに関する質問を始めると、すべてのコンテキストが利用できます。

セキュリティ上のベストプラクティス

1. 環境変数を使用して機密クレデンシャルを保存します。

{
  "mcpServers": {
    "mysql": {
      "command": "mysql-mcp-server",
      "args": ["mysql://${MYSQL_USER}:${MYSQL_PASSWORD}@host:3306/mydb"]
    }
  }
}

2. MySQLユーザーには最小限の必要な権限（読み取り専用アクセス）を付与します。
3. 強力なパスワードを使用し、セキュリティ上のベストプラクティスに従います。
4. クレデンシャルを含む設定ファイルをバージョン管理システムにコミットしないでください。

📚 ドキュメント

コンポーネント

ツール

• query
  • 接続されたデータベースに対して読み取り専用のSQLクエリを実行します。
  • 入力: sql（文字列）：実行するSQLクエリ
  • すべてのクエリは読み取り専用トランザクションで実行されます。
  • 提供されたクレデンシャルを使用して自動的に認証が処理されます。

リソース

サーバーは各テーブルのデータベーススキーマ情報を提供します。

• テーブルスキーマ（mysql://<host>/<table>/schema）
  • 各テーブルのJSONスキーマ情報
  • 列名とデータ型を含む
  • データベースメタデータから自動的に検出される
  • 提供されたクレデンシャルを使用して認証されたアクセス

📄 ライセンス

このMCPサーバーはMITライセンスの下で公開されています。これは、MITライセンスの条項と条件に従い、ソフトウェアを自由に使用、変更、配布できることを意味します。詳細については、プロジェクトリポジトリのLICENSEファイルを参照してください。