MCP Tools Reference: dataform.googleapis.com

ツール: search_files

検索フィルタに一致する Dataform ワークスペース内のファイルとディレクトリを検索します。

大規模なリポジトリで名前または拡張子でファイルを検索する場合は、query_directory_contents ツールを使用してディレクトリを再帰的に一覧表示する代わりに、このツールを使用します。

workspace パラメータの値は projects/{project_id}/locations/{location}/repositories/{repository}/workspaces/{workspace} 形式にする必要があります。

filter パラメータ値は結果を制限します。フィルタリングは path フィールド（path="*.sqlx" や path="definitions/model.sqlx" など）でのみサポートされています。

次のコードサンプルは、curl を使用して search_files MCP ツールを呼び出す方法を示しています。

Curl リクエスト 
curl --location 'https://dataform.googleapis.com/mcp' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "search_files",
    "arguments": {
      // Provide these details according to the MCP tool specification.
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

入力スキーマ

ファイル検索リクエスト パラメータを含む構成。

SearchFilesRequest

JSON 表現 
{
  "workspace": string,
  "pageSize": integer,
  "pageToken": string,
  "filter": string
}
フィールド
workspace

string

必須。ワークスペースの名前。
pageSize

integer

省略可。返す検索結果の最大数。サーバーが返すアイテムが、リクエストされた数よりも少ないことがあります。指定しない場合は、サーバーで適切なデフォルトが選択されます。
pageToken

string

省略可。前回の SearchFilesRequest 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、page_size を除く SearchFilesRequest に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。
filter

string

省略可。フィルタリング形式で返されるリストの省略可能なフィルタ。現在、フィルタリングは path フィールドでのみサポートされています。詳しくは、https://google.aip.dev/160 をご覧ください。

出力スキーマ

ファイル検索レスポンスのクライアント向け表現。

SearchFilesResponse

JSON 表現 
{
  "searchResults": [
    {
      object (SearchResult)
    }
  ],
  "nextPageToken": string
}
フィールド
searchResults[]

object (SearchResult)

一致する結果のリスト。
nextPageToken

string

省略可。次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

SearchResult

JSON 表現 
{

  // Union field entry can be only one of the following:
  "file": {
    object (FileSearchResult)
  },
  "directory": {
    object (DirectorySearchResult)
  }
  // End of list of possible types for union field entry.
}
フィールド
共用体フィールド entry。エントリの内容。entry は次のいずれかになります。
file

object (FileSearchResult)

検索結果がファイルの場合の詳細。
directory

object (DirectorySearchResult)

検索結果がディレクトリの場合の詳細。

FileSearchResult

JSON 表現 
{
  "path": string
}
フィールド
path

string

ワークスペースのルートからの相対ファイル システム パス。

DirectorySearchResult

JSON 表現 
{
  "path": string
}
フィールド
path

string

ワークスペースのルートからの相対ファイル システム パス。

ツールのアノテーション

ツールのアノテーションは、特定のツールの基本的なリスクを説明するために MCP クライアントに送信されます。ほとんどのクライアントはこれらのヒントを信頼できないものとして扱いますが、確認プロンプトをユーザーに送信するタイミングを決定するために使用できます。

タイトル文字列とともに、次のブール値のヒントが次のように定義されています。

  • readOnlyHint: true の場合、ツールは環境を変更しません。デフォルトは false です。
  • destructiveHint: true の場合、ツールは破壊的なアクションを実行できます。false の場合、ツールは追加アクションのみを実行できます。デフォルト値は true です。
  • idempotentHint: true の場合、同じ引数でツールを繰り返し呼び出しても、環境に影響はありません。デフォルトは false です。
  • openWorldHint: true の場合、ツールは外部エンティティの「オープン ワールド」とやり取りできます。false の場合、ツールは内部エンティティとのみやり取りできます。たとえば、ウェブ検索ツールはオープン ワールドですが、メモリツールはオープン ワールドではありません。

破壊的ヒント: ❌ | べき等ヒント: ✅ | 読み取り専用ヒント: ✅ | オープン ワールド ヒント: ❌