MCP Tools Reference: dataform.googleapis.com

Tool: search_files

Dateien und Verzeichnisse in einem Dataform-Arbeitsbereich finden, die einem Suchfilter entsprechen

Verwenden Sie dieses Tool anstelle des rekursiven Auflistens von Verzeichnissen mit dem Tool query_directory_contents, wenn Sie eine Datei anhand des Namens oder der Erweiterung in einem großen Repository suchen.

Der Parameterwert workspace muss das Format projects/{project_id}/locations/{location}/repositories/{repository}/workspaces/{workspace} haben.

Der Parameterwert filter schränkt die Ergebnisse ein. Das Filtern wird nur für das Feld path unterstützt, z. B. path="*.sqlx" oder path="definitions/model.sqlx".

Das folgende Codebeispiel zeigt, wie Sie mit curl das MCP-Tool search_files aufrufen.

Curl-Anfrage 
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
}'

Eingabeschema

Konfiguration mit Parametern für die Dateisuchanfrage.

SearchFilesRequest

JSON-Darstellung 
{
  "workspace": string,
  "pageSize": integer,
  "pageToken": string,
  "filter": string
}
Felder
workspace

string

Erforderlich. Der Name des Arbeitsbereichs.
pageSize

integer

Optional. Maximale Anzahl der zurückzugebenden Suchergebnisse. Der Server gibt möglicherweise weniger Elemente als angefordert zurück. Wenn kein Wert angegeben wurde, wählt der Server ein geeignetes Standardmodell aus.
pageToken

string

Optional. Ein Seitentoken, das von einem vorherigen SearchFilesRequest-Aufruf empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen für SearchFilesRequest bereitgestellten Parameter mit Ausnahme von page_size mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat.
filter

string

Optional. Optionaler Filter für die zurückgegebene Liste im Filterformat. Derzeit wird das Filtern nur für das Feld path unterstützt. Weitere Informationen finden Sie unter https://google.aip.dev/160.

Ausgabeschema

Clientseitige Darstellung einer Antwort auf eine Dateisuche.

SearchFilesResponse

JSON-Darstellung 
{
  "searchResults": [
    {
      object (SearchResult)
    }
  ],
  "nextPageToken": string
}
Felder
searchResults[]

object (SearchResult)

Liste der übereinstimmenden Ergebnisse.
nextPageToken

string

Optional. Ein Token, das als page_token gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.

SearchResult

JSON-Darstellung 
{

  // 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.
}
Felder
Union-Feld entry. Der Inhalt des Eintrags. Für entry ist nur einer der folgenden Werte zulässig:
file

object (FileSearchResult)

Details, wenn das Suchergebnis eine Datei ist.
directory

object (DirectorySearchResult)

Details, wenn ein Suchergebnis ein Verzeichnis ist.

FileSearchResult

JSON-Darstellung 
{
  "path": string
}
Felder
path

string

Dateisystempfad relativ zum Arbeitsbereichs-Root.

DirectorySearchResult

JSON-Darstellung 
{
  "path": string
}
Felder
path

string

Dateisystempfad relativ zum Arbeitsbereichs-Root.

Tool-Annotationen

Tool-Anmerkungen werden an MCP-Clients gesendet, um das grundlegende Risiko eines bestimmten Tools zu beschreiben. Die meisten Clients behandeln diese Hinweise als nicht vertrauenswürdig, sie können aber verwendet werden, um zu entscheiden, wann eine Bestätigungsaufforderung an einen Nutzer gesendet wird.

Zusammen mit dem Titelstring sind die folgenden booleschen Hinweise definiert:

  • readOnlyHint: Wenn „true“, ändert das Tool seine Umgebung nicht. Standardeinstellung: false.
  • destructiveHint: Wenn „true“, kann das Tool destruktive Aktionen ausführen. Wenn „false“, kann das Tool nur additive Aktionen ausführen. Standardeinstellung: true.
  • idempotentHint: Wenn „true“, hat das wiederholte Aufrufen des Tools mit denselben Argumenten keine zusätzlichen Auswirkungen auf die Umgebung. Standardeinstellung: false.
  • openWorldHint: Wenn „true“, kann das Tool mit einer „offenen Welt“ externer Einheiten interagieren. Wenn „false“, kann das Tool nur mit internen Einheiten interagieren. Ein Web-Suchtool wäre beispielsweise frei verfügbar, ein Tool für das Gedächtnis jedoch nicht.

Destruktiver Hinweis: ❌ | Idempotenter Hinweis: ✅ | Nur-Lese-Hinweis: ✅ | Open-World-Hinweis: ❌