Soracom

Users

開発者向け
Home 開発者向け SORACOM Query MCP サーバー リファレンス

利用できるツール

SORACOM Query MCP サーバーは、AI エージェントに次の 5 つのツールを公開します。

クエリは非同期で実行されます

start_query は SQL の実行を開始し、queryId を返します。実行結果は get_query_result または get_query_export で取得します。取得時のステータスが STARTING、RUNNING、EXPORTING の場合は、まだ実行中です。AI エージェントが、完了するまで取得を繰り返します。

いずれのツールも coverage にカバレッジタイプを指定します。get_query_usage 以外は、省略すると jp (日本カバレッジ) として扱われます。1 つのクエリを開始してから結果を取得するまで、同じカバレッジタイプを指定してください。

get_query_schema

SORACOM Query のスキーマリファレンスを取得します。参照できるテーブル (ビュー)、カラムとその意味、結合できる関係、指定できる期間、データの反映タイミング、クエリの例が含まれます。同じ内容は、スキーマリファレンスサイト でも確認できます。

SQL を組み立てる前にこのツールを実行すると、AI エージェントがテーブル名やカラム名を推測せずに済みます。

パラメーター説明
coveragejp (日本カバレッジ) または g (グローバルカバレッジ)。省略すると jp として扱われます。

get_query_usage

指定したカバレッジタイプのクエリ実行回数を取得します。プランに含まれる回数、使用済みの回数、残数、使い切ったかどうか (exhausted) を返します。このツールはクエリ実行回数を消費しません。

Business プランの場合、返される回数は月額利用料金に含まれる 2,000 回に対するものです。使い切ったと表示されたあともクエリは実行でき、超過分は料金が発生します。

exhausted の意味は、プランによって異なります。Free プランでは、以降のクエリを実行できないことを表します。Business プランでは、含まれる回数を使い切って、以降のクエリに料金が発生することを表します。Enterprise プランでは、契約内容に従います。

パラメーター説明
coverage *jp (日本カバレッジ) または g (グローバルカバレッジ)。このツールでは省略できません。

start_query

SQL の実行を開始します。SQL の実行が始まった時点で、クエリ実行回数を 1 回消費します。実行時間の上限に達した場合や、SQL の実行後に失敗した場合も消費します。

パラメーター説明
sql *実行する SQL。1 文字以上 3,000 文字以下で指定します。
coveragejp (日本カバレッジ) または g (グローバルカバレッジ)。省略すると jp として扱われます。
fromクエリの対象期間の開始日時。ISO 8601 形式 (タイムゾーンのオフセットを含む) で指定します。
toクエリの対象期間の終了日時。from より後の日時を指定します。to を指定する場合は from も指定してください。

get_query_result

クエリの結果を JSON の行データとして取得します。分析や可視化の途中で結果を確認する場合に利用します。

パラメーター説明
queryId *start_query が返した ID。
coveragestart_query で指定したカバレッジタイプ。省略すると jp として扱われます。
maxRows取得する行数。1 以上 1,000 以下で指定します。既定値は 100 です。

結果が maxRows またはデータサイズの上限 (1 MiB) を超えた場合は、途中までの行を返し、切り詰めたことと、その理由をあわせて返します。すべての行が必要な場合は get_query_export を利用してください。

get_query_export

クエリの結果をファイルとして取得します。一時的なダウンロード用のリンクを返します。行数やデータサイズの上限はありません。

パラメーター説明
queryId *start_query が返した ID。
coveragestart_query で指定したカバレッジタイプ。省略すると jp として扱われます。
formatcsv (既定値)、parquet、jsonl (gzip 圧縮) のいずれか。
ダウンロード用のリンクの取り扱いに注意してください

get_query_export が返すリンクは、有効期限内であれば、リンクを知っている人がクエリの結果をダウンロードできます。第三者に共有しないでください。