mcpField
S
surrealql-functions

surrealql-functions

github.com/surrealdbデータ・データベース28424 回インストール4 週間前に更新
リポジトリ

surrealql-functions について

surrealql-functionsは、SurrealDBの組み込み関数の動作やシグネチャを調べるスキルです。surrealql-language-serverを通じてインストール済みのSurrealQL文法を使うため、補完やシグネチャ情報はそのバージョンに対応します。

主な機能

  1. 01バージョンに応じた関数補完
  2. 02型とシグネチャのホバー表示
  3. 03入力中のシグネチャヘルプ
  4. 04名前空間内の関数検索

活用シーン

  1. 01関数の正確な引数の確認
  2. 02名前空間内の関数の調査
  3. 03インストール済みSurrealDBの関数確認

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/surrealdb/agent-skills --skill surrealql-functions

インストール後、Claude Code で/surrealql-functionsを入力して読み込まれたか確認します。

同梱ファイルreferences/catalog.md

詳細

SurrealQL 関数

SurrealDB には、名前空間（string::、array::、math::、type:: など）ごとに分類された数百の組み込み関数があります。関数名やシグネチャはリリースごとに変更されるため、信頼できる最新バージョンの情報源は、記憶ではなく SurrealQL のツールです。

  • surrealql-language-server（LSP）— 組み込み関数の補完、型情報と関数シグネチャを表示するホバー、シグネチャヘルプを提供します。
  • surrealql-tree-sitter — LSP が解析に使用する文法です（SurrealDB v3 以降が対象です）。

各関数の信頼できるドキュメントを確認するには、references/catalog.md を参照してください。

このスキルを使用する場面

  • 組み込み関数の動作や、正確な引数を調べるとき
  • .surql ファイルで、リアルタイムの補完、ホバー、シグネチャヘルプを利用するとき
  • インストール済みの SurrealDB バージョンに関数が存在するか、期待するシグネチャを持つか確認するとき（名前変更または削除された関数の出力を防げます）

セットアップ

crates.io から言語サーバーをインストールします。公開済みのクレートには文法が含まれているため、tree-sitter を別途チェックアウトする必要はありません。

cargo install surrealql-language-server
#   -> installs the `surrealql-language-server` binary on your PATH (~/.cargo/bin)

PATH 上にあることを確認します。

surrealql-language-server --help
ソースからビルドする（任意）

開発時、または未リリースの変更を追跡する場合にのみ必要です。ソースからのビルドには、tree-sitter 文法を隣接するディレクトリとしてチェックアウトする必要があります。

git clone https://github.com/surrealdb/surrealql-language-server.git
cd surrealql-language-server
bash scripts/setup-grammar.sh                 # clones/updates the grammar
#   ...or: export TREE_SITTER_SURREALQL_DIR=/abs/path/to/surrealql-tree-sitter
cargo build --release                         # -> target/release/surrealql-language-server

ブラウザーやエディターに組み込む場合は、代わりに bash scripts/build-wasm.sh を使って wasm-bindgen npm パッケージをビルドします（pkg/ に出力されます）。

エディターとの統合

エディターの LSP クライアントで、.surql／surrealql 言語用の surrealql-language-server バイナリを指定します。汎用的な標準入出力 LSP の設定は次のとおりです。

  • コマンド： surrealql-language-server（またはソースからビルドした場合は絶対パス）
  • ファイル形式： *.surql

サーバーは、インストール済みの文法バージョンに基づいて次の機能を提供します。

  • 補完 — 名前空間ごとの組み込み関数名、フィールド名、record<table> 型、キーワード
  • ホバー — 型情報、権限の状態、関数シグネチャ
  • シグネチャヘルプ — 呼び出しの入力中に表示される引数の形式

関数を調べる

  • LSP に接続した .surql バッファーを開くか、新しく作成します。
  • 名前空間のプレフィックス（例：string::）を入力し、補完を実行すると、インストール済みバージョンで利用できるその名前空間の組み込み関数が一覧表示されます。
  • 関数呼び出しにカーソルを合わせるか、括弧内でシグネチャヘルプを呼び出すと、正確なシグネチャと引数の型を確認できます。

補完とシグネチャはインストール済みの文法から取得されるため、現在の SurrealDB バージョンが反映されます。これにより、古いリリースの情報に基づく古い関数や名前変更済みの関数を使うのを防げます。各名前空間の詳細なドキュメントと例については、references/catalog.md のリンクを参照してください。

コメント

Markdown 対応