Surrealdb MCP Server

🚀 SurrealDB MCP サーバードキュメント

SurrealDB MCP サーバーは、SurrealDB との接続や操作を簡素化するためのツールです。このドキュメントでは、インストール方法、基本的な使い方、高度な設定などを説明します。

🚀 クイックスタート

基本構成例

以下は mcp.json ファイルの基本的な構成例です。

{
  "mcpServers": {
    "surrealdb": {
      "command": "node",
      "args": ["$(npm prefix)/bin/surrealdb-mcp-server"],
      "env": {
        "SURREALDB_URL": "ws://localhost:8000",
        "SURREALDB_NS": "my-namespace",
        "SURREALDB_DB": "my-database",
        "SURREALDB_USER": "root",
        "SURREALDB_PASS": "password"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

構成パラメータの説明

• command: 実行コマンドの実行可能ファイルのパスを指定します。
• args: コマンドに渡すパラメータのリストです。
• env: SurrealDB インスタンスに接続するための環境変数を設定します。
• disabled: この MCP サーバーを無効にするかどうか（デフォルトは false）。
• autoApprove: 自動承認する操作のリストです。

✨ 主な機能

• 複数の MCP サーバーを構成できます。
• 環境変数を使用して SurrealDB インスタンスに接続できます。
• バッチ操作と詳細なログ記録をサポートしています。

📦 インストール

npm を使用したインストール

surrealdb-mcp-server をシステムにグローバルにインストールします。

npm install -g surrealdb-mcp-server

npx を使用した実行

インストールせずに npx を使用して直接実行します。

npx surrealdb-mcp-server

💻 使用例

基本的な使用法

const { MCP } = require('surrealdb-mcp-server');
// または ES6 モジュール構文を使用する場合：
import { MCP } from 'surrealdb-mcp-server';

高度な使用法

// mcp.json で複数のサーバー構成を追加する
{
  "mcpServers": {
    "surrealdb1": { ... },
    "surrealdb2": { ... }
  }
}

📚 ドキュメント

プロジェクトへの統合

プロジェクトのルートディレクトリに mcp.json ファイルを作成し、必要に応じて複数の MCP サーバー構成を追加します。

cd your-project
npm init -y # package.json がない場合

そして、コード内で MCP サーバーをインポートして使用します。

const { MCP } = require('surrealdb-mcp-server');
// または ES6 モジュール構文を使用する場合：
import { MCP } from 'surrealdb-mcp-server';

環境変数の構成

以下は設定が必要な環境変数とその説明です。

🔧 技術詳細

バッチ操作のサポート

MCP サーバーはバッチ操作リクエストをサポートしており、必要に応じて機能を拡張できます。

// mcp.json で複数のサーバー構成を追加する
{
  "mcpServers": {
    "surrealdb1": { ... },
    "surrealdb2": { ... }
  }
}

ログ記録

MCP サーバーは詳細なログ記録機能をサポートしており、ログ出力形式とレベルをカスタマイズできます。

// mcp.json でログ構成を追加する
{
  "logging": {
    "level": "debug",
    "outputFile": "./mcp.log"
  }
}

クライアントの作成

以下は簡単なクライアント実装の例です。

const { createMCPClient } = require('surrealdb-mcp-server');

async function main() {
  const client = await createMCPClient({
    serverName: 'surrealdb',
    command: 'node',
    args: ['$(npm prefix)/bin/surrealdb-mcp-server'],
    env: {
      SURREALDB_URL: 'ws://localhost:8000',
      SURREALDB_NS: 'my-namespace',
      SURREALDB_DB: 'my-database',
      SURREALDB_USER: 'root',
      SURREALDB_PASS: 'password'
    }
  });

  // データベース操作を実行する
  await client.execute('SELECT * FROM users');
}

main().catch(console.error);

その他の注意事項

権限問題

一部のシステムでは、MCP サーバーを管理者権限で実行する必要がある場合があります。例えば、Windows では runas コマンドを使用します。

runas /user:Administrator npm start

パフォーマンス最適化

最高のパフォーマンスを得るには、SurrealDB インスタンスと MCP サーバーの構成が十分なハードウェアリソース（十分なメモリと CPU リソースを含む）を持っていることを確認してください。

📄 ライセンス

ドキュメントにライセンス情報が記載されていないため、このセクションは省略されています。

トラブルシューティング

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

"Cannot find module 'surrealdb-mcp-server'" のようなエラーが発生した場合は、以下の手順を試してみてください。

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

接続問題

"Failed to connect to SurrealDB" エラーが発生した場合は、以下の内容を確認してください。

1. SurrealDB インスタンスが実行中であることを確認する。
2. ネットワーク接続が正常であることを確認する。
3. 環境変数が正しく設定されていることを確認する。

使用シナリオ

ローカル開発

ローカルプロジェクトで MCP サーバーを使用する場合は、開発依存関係として package.json に追加できます。

{
  "name": "my-project",
  "version": "1.0.0",
  "scripts": {
    "start": "surrealdb-mcp-server"
  },
  "devDependencies": {
    "surrealdb-mcp-server": "^1.0.0"
  }
}

そして、以下のコマンドを実行します。

npm install
npm start

本番環境

本番環境で使用する場合は、MCP サーバーをサービスとして実行することをおすすめします。例えば、Linux システムではシステムサービスとして登録できます。

終わりに

SurrealDB MCP サーバーを選んでいただき、ありがとうございます。使用中に何か問題や提案があれば、いつでも技術サポートチームにお問い合わせください。