MCP Tools Reference: dataform.googleapis.com

Alat: read_file

Menampilkan konten file di dalam ruang kerja Dataform, termasuk perubahan yang belum di-commit.

Gunakan alat ini untuk membaca file workflow_settings.yaml ruang kerja, yang menyimpan setelan kompilasi pipeline seperti set data BigQuery default, lokasi default, dan versi inti Dataform. File ini berada di root direktori pipeline, yang tidak harus berupa root ruang kerja, karena repositori dapat menyimpan beberapa pipeline dalam subdirektori. Temukan file dengan alat search_files.

Untuk membaca file yang di-commit langsung dari repositori tanpa ruang kerja, gunakan alat read_repository_file. Perhatikan bahwa read_repository_file hanya berfungsi di repositori yang tidak terhubung ke host Git jarak jauh.

Nilai parameter workspace harus dalam format projects/{project_id}/locations/{location}/repositories/{repository}/workspaces/{workspace}.

Nilai parameter path adalah jalur relatif ke file dari root ruang kerja. Jangan gunakan penelusuran direktori, seperti ... Jalur yang valid dapat diperoleh menggunakan alat query_directory_contents atau search_files.

Nilai parameter revision secara opsional memilih revisi Git tertentu dari file. Jika tidak ada, status file yang saat ini belum di-commit akan ditampilkan.

Contoh kode berikut menunjukkan cara menggunakan curl untuk memanggil alat MCP read_file.

Permintaan 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": "read_file",
    "arguments": {
      // Provide these details according to the MCP tool specification.
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

Skema Input

Pesan permintaan ReadFile.

ReadFileRequest

Representasi JSON 
{
  "workspace": string,
  "path": string,
  "revision": string
}
Kolom
workspace

string

Wajib. Nama ruang kerja.
path

string

Wajib. Jalur lengkap file termasuk nama file, relatif terhadap root ruang kerja.
revision

string

Opsional. Revisi Git file yang akan ditampilkan. Jika dibiarkan kosong, konten path saat ini akan ditampilkan.

Skema Output

Pesan respons ReadFile.

ReadFileResponse

Representasi JSON 
{
  "fileContents": string
}
Kolom
fileContents

string (bytes format)

Isi file.

String berenkode base64.

Anotasi Alat

Anotasi alat dikirim ke klien MCP untuk menjelaskan risiko dasar alat tertentu. Sebagian besar klien memperlakukan petunjuk ini sebagai tidak tepercaya, tetapi petunjuk ini dapat digunakan untuk memutuskan kapan perintah konfirmasi dapat dikirim ke pengguna.

Selain string judul, petunjuk boolean berikut ditentukan sebagai berikut:

  • readOnlyHint: Jika benar, alat tidak akan mengubah lingkungannya. Default: false.
  • destructiveHint: Jika benar, alat dapat melakukan tindakan destruktif. Jika salah (false), alat hanya dapat melakukan tindakan tambahan. Default: true.
  • idempotentHint: Jika benar (true), memanggil alat berulang kali dengan argumen yang sama tidak akan memberikan efek tambahan pada lingkungannya. Default: false.
  • openWorldHint: Jika benar, alat dapat berinteraksi dengan 'dunia terbuka' entitas eksternal. Jika salah (false), alat hanya dapat berinteraksi dengan entitas internal. Misalnya, alat penelusuran web akan menjadi open world, sedangkan alat memori tidak akan menjadi open world.

Petunjuk Destruktif: ❌ | Petunjuk Idempoten: ✅ | Petunjuk Hanya Baca: ✅ | Petunjuk Dunia Terbuka: ❌