Singlestore MCP Server

🚀 単店データベースMCPプロトコルサーバー

このサーバーはSingleStoreデータベース用に設計された単プロセスのMCP（Multi-Protocol Communications Protocol）プロトコルサーバーです。標準のMCPプロトコルまたはHTTPベースのServer-Sent Events (SSE) を通じた通信をサポートしています。

🚀 クイックスタート

このサーバーを使用することで、SingleStoreデータベースとの通信が容易に行えます。以下の手順に従ってサーバーをセットアップしましょう。

📦 インストール

Node.jsを使用してインストールします。

npm install mcp-server-singlestore

サーバーを起動します。

node src/index.ts

🔧 設定

実行時に必要な環境変数は以下の通りです。

✨ 主な機能

• データベース接続：MCPプロトコルまたはHTTPを通じてSingleStoreデータベースに接続できます。
• クエリ実行：SQLクエリを実行し、結果を返すことができます。
• SSEサポート：HTTPベースのストリームデータ転送機能を提供し、リアルタイムデータのプッシュに適しています。

💻 使用例

基本的な使用法

# 依存関係のインストール
npm install mcp-server-singlestore

# サーバーの起動（環境変数が設定されていることを前提）
node src/index.ts

設定ファイルの例

const config = {
  singleStoreHost: 'localhost',
  singleStorePort: 3307,
  singleStoreUser: 'admin',
  singleStorePassword: 'password',
  // オプション設定
  sslCaBundle: '/path/to/ca.pem',
  mcpServerPort: 4000,
  sseEnabled: true,
  ssePort: 4001
};

require('mcp-server-singlestore').start(config);

Claudeでの使用

function useMCPTool(commands) {
  return {
    connectDatabase(options) {
      // データベース接続ロジックの実装
    },
    executeQuery(query, params) {
      // クエリを実行し、結果を返す
    }
  };
}

export default useMCPTool;

Windsurfでの設定

const config = {
  type: 'singlestore',
  host: 'localhost',
  port: 3307,
  user: 'admin',
  password: 'password'
};

// データベース接続の初期化
const db = new Database(config);

Cursorでの使用

const { Cursor } = require('cursor');

const cursor = new Cursor({
  databaseConfig: {
    type: 'singlestore',
    host: 'localhost',
    port: 3307,
    user: 'admin',
    password: 'password'
  }
});

// クエリの例
cursor.query('SELECT * FROM users LIMIT 10', (err, result) => {
  if (err) throw err;
  console.log(result);
});

⚠️ 重要提示

• クレデンシャル管理：クレデンシャルをバージョン管理システムにコミットしないでください。
• ネットワーク隔離：本番環境では、データベースとアプリケーションサービスを制御されたネットワーク内に配置することをおすすめします。
• 権限管理：データベース接続ユーザーの権限を厳密に制限してください。

🔍 プロジェクト構造

src/
├── index.ts                 # エントリーファイル
├── server.ts                # MCPサーバーの実装
└── sseServer.ts             # SSEサーバーの実装

👨‍💻 開発

依存関係のインストール

npm install express mysql2

開発環境の起動

npm run dev

🛠️ トラブルシューティング

接続問題

• ターゲットデータベースが実行中かどうかを確認してください。
• ネットワーク接続が正常かどうかを確認してください。
• 提供されたクレデンシャルが正しいかどうかを検証してください。

クエリ問題

• クエリ構文が正しいことを確認してください。
• 関連するデータテーブルと列にアクセスする権限があることを確認してください。

🤝 貢献ガイド

問題を発見した場合は、GitHubを通じてIssueまたはPull Requestを提出してください。

📄 ライセンス

このプロジェクトはMITライセンスの下で公開されています。詳細な条項はLICENSEファイルを参照してください。