Nsxdavid Surrealdb MCP Server

🚀 超現実データベース MCP サーバーガイド

このガイドでは、超現実データベース MCP サーバーのインストール、設定、使用方法、トラブルシューティングなどについて説明します。

🚀 クイックスタート

📦 インストール

グローバルインストール方法（推奨）

ターミナルで以下のコマンドを実行し、SurrealDB の MCP サーバーをグローバルにインストールします。

npm install -g surrealdb-mcp-server

npx 方法（テスト用のみ）

npx を使用して、すぐに実行することもできます。

npx surrealdb-mcp-server

🔧 設定

MCP サーバーは、設定ファイルまたはコマンドライン引数で設定できます。以下は、デフォルトの設定ファイルの例です。

{
  "mcpServers": {
    "surrealdb": {
      "command": "node",
      "args": ["$(npm which -g surrealdb-mcp-server)"],
      "env": {
        "SURREALDB_URL": "ws://localhost:8000",
        "SURREALDB_NS": "my_namespace",
        "SURREALDB_DB": "my_database",
        "SURREALDB_USER": "my_user",
        "SURREALDB_PASS": "my_password"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

環境変数を使用する

環境変数を使用して設定することもできます。

SURREALDB_URL=ws://localhost:8000
SURREALDB_NS=my_namespace
SURREALDB_DB=my_database
SURREALDB_USER=my_user
SURREALDB_PASS=my_password

💻 使用例

基本的な使用法

シナリオ 1: 独立したサーバーとして実行

surrealdb-mcp-server --port 8001 --namespace my_ns --database my_db --user my_user --password my_pass

シナリオ 2: Node.js アプリケーションに統合

アプリケーションで MCP クライアントを使用します。

const { Client } = require('surrealdb-mcp-client');
const client = new Client({
  url: 'ws://localhost:8000',
  ns: 'my_namespace',
  db: 'my_database',
  user: 'my_user',
  pass: 'my_password'
});

client.query('SELECT * FROM my_table').then(console.log);

高度な使用法

シナリオ 3: 本番環境での使用

本番環境では、Docker を使用したコンテナ化デプロイをおすすめします。

FROM node:16

WORKDIR /app

COPY package*.json ./

RUN npm install -g surrealdb-mcp-server

CMD ["surrealdb-mcp-server", "--port", "8001", "--namespace", "prod_ns", "--database", "prod_db", "--user", "prod_user", "--password", "prod_pass"]

シナリオ 4: 拡張と負荷分散

可用性を向上させるために、リバースプロキシ（Nginx など）を使用して MCP サーバーを負荷分散することができます。

upstream surrealdb_mcp {
    server localhost:8001;
    server localhost:8002;
}

server {
    listen 80;

    location / {
        proxy_pass http://surrealdb_mcp;
    }
}

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

一般的な問題

"モジュールが見つからない" エラー

「モジュール'surrealdb-mcp-server' が見つかりません」のようなエラーが発生した場合は、以下の手順を試してください。

1. グローバルインストールを確認する：npm list -g surrealdb-mcp-server
2. 設定内のパスが実際のインストールパスと一致することを確認する
3. 再インストールする：npm install -g surrealdb-mcp-server

接続エラー

「SurrealDB に接続できません」のエラーが発生した場合は、以下を確認してください。

1. SurrealDB サーバーが実行中であることを確認する
2. URL、名前空間、データベース、ユーザー、パスワードが正しく設定されていることを確認する

💡 ベストプラクティス

パフォーマンス最適化

1. WebSocket を使用してリアルタイム通信を行う
2. クエリでの JOIN 操作を減らす
3. 定期的にデータベースのメンテナンスと最適化を行う

セキュリティに関する提案

1. 強力なパスワードポリシーを使用する
2. SSL 証明書を有効にして暗号化通信を行う
3. クライアントの接続数を制限する

📚 詳細ドキュメント

コマンドラインオプション

以下は、surrealdb-mcp-server の一般的なコマンドラインオプションです。

--port <number>      サーバーがリッスンするポートを指定します。デフォルトは 8000 です。
--namespace <string>  デフォルトの名前空間を指定します。
--database <string>   デフォルトのデータベースを指定します。
--user <string>       デフォルトのユーザー名を指定します。
--password <string>   デフォルトのパスワードを指定します。

環境変数の参照

以下は、サポートされている主要な環境変数です。

SURREALDB_URL        サーバーの接続アドレス。デフォルトは ws://localhost:8000 です。
SURREALDB_NS         デフォルトの名前空間。
SURREALDB_DB         デフォルトのデータベース。
SURREALDB_USER       デフォルトのユーザー名。
SURREALDB_PASS       デフォルトのパスワード。

🤝 貢献ガイド

貢献いただける場合は、大歓迎です！コードの提出や問題の報告については、GitHub リポジトリ を参照してください。