Saat memanggil Alibaba Cloud OpenAPI, Anda perlu mencari nama API, menyusun parameter permintaan, serta menangani pagination dan panggilan lintas wilayah. OpenAPI MCP Server Core Edition (selanjutnya disebut “Core Edition”) menyediakan 15 alat bawaan yang memungkinkan pemanggilan API, orkestrasi multi-langkah, manajemen sumber daya Terraform, dan pencarian dokumentasi melalui bahasa alami. Alat ini kompatibel dengan AI Agent umum (misalnya Qoder, Claude Code, CodeX). Berikut dijelaskan fungsi, parameter, dan penggunaan masing-masing alat.
Prasyarat
Konfigurasi dan integrasi Core Edition MCP Server telah selesai. Untuk detailnya, lihat OpenAPI MCP Server.
Verifikasi koneksi MCP. Masukkan “List Alibaba Cloud compute-related products” dalam percakapan AI Agent. Jika daftar produk dikembalikan, koneksi berfungsi dengan baik.
Ikhtisar Alat
Core Edition mencakup 15 alat, dikelompokkan ke dalam lima kategori berikut:
Kategori | Alat | Deskripsi |
API Discovery | List all Alibaba Cloud products and metadata | |
List all APIs under a specified product | ||
Get complete parameter definitions of an API | ||
Recommend matching OpenAPI based on natural language description | ||
List regions supported by a product | ||
API Execution | Generate CLI command (without executing) | |
Execute Alibaba Cloud CLI command | ||
Advanced Orchestration | Execute Python scripts with multi-API orchestration | |
Poll asynchronous task status | ||
Infrastructure as Code | Generate OSS presigned URL | |
Execute Terraform HCL code | ||
Document Search | Search documentation | |
Get document Markdown content | ||
Browse product document directory tree | ||
Match document content by keyword |
Detail Alat
API Discovery
ListProducts
Saat perlu mengetahui produk Alibaba Cloud yang tersedia, AI Agent menggunakan alat ini untuk menanyakan katalog produk. Misalnya, memasukkan “What compute-related products does Alibaba Cloud have” menyebabkan AI Agent mengekstraksi kata kunci dan menyaring daftar produk sesuai kebutuhan.
Panduan Penggunaan
Tentukan kata kunci produk dalam deskripsi. Misalnya, “What compute-related products does Alibaba Cloud have” lebih baik daripada “What products does Alibaba Cloud have”.
Hasil kueri dapat digunakan sebagai konteks untuk percakapan selanjutnya. Misalnya, pertama tanyakan “What database products are available”, lalu lanjutkan dengan detail operasional spesifik untuk produk tertentu.
ListApis
Saat operasi pengguna melibatkan produk tertentu tetapi AI Agent perlu mengonfirmasi operasi API yang tepat, alat ini digunakan untuk menelusuri daftar API produk tersebut. Misalnya, memasukkan “Allocate a public IP to an ECS instance” dapat menyebabkan AI Agent terlebih dahulu menanyakan API ECS mana yang relevan, lalu memilih yang sesuai untuk dieksekusi.
Panduan Penggunaan
Jelaskan produk dan aksi sejelas mungkin saat menggambarkan maksud operasional. Misalnya, “allocate a public IP to an ECS instance” lebih baik daripada “allocate IP”.
GetApiDefinition
Saat permintaan pengguna melibatkan pemanggilan API, AI Agent biasanya terlebih dahulu menemukan API target melalui SearchApis atau ListApis, lalu menggunakan alat ini untuk mendapatkan definisi parameter API, dan akhirnya menyusun pemanggilan yang benar. Misalnya, memasukkan “Query ECS instances in Hangzhou region” menyebabkan AI Agent terlebih dahulu menemukan API DescribeInstances, lalu mengonfirmasi parameter yang diperlukan melalui alat ini sebelum mengeksekusi.
Panduan Penggunaan
Jelaskan maksud operasional sejelas mungkin. Setelah AI Agent menemukan API yang benar, alat ini secara otomatis mengonfirmasi parameter dan mengeksekusi.
SearchApis
Saat nama API yang tepat tidak diketahui, AI Agent menggunakan alat ini untuk mencocokkan OpenAPI Alibaba Cloud yang sesuai berdasarkan deskripsi bahasa alami. Misalnya, memasukkan “How to view ECS instance monitoring data” menyebabkan AI Agent mencari dan menemukan API pemantauan yang relevan.
Panduan Penggunaan
Sertakan nama produk dalam deskripsi. Misalnya, “query ECS security group rules” lebih baik daripada “query security groups”.
Pisahkan kebutuhan kompleks menjadi beberapa pertanyaan independen, masing-masing sesuai dengan satu operasi API.
Jika nama API sudah diketahui, sebutkan langsung ke AI Agent (misalnya, “use DescribeInstances to query”) untuk melewati langkah pencarian.
ListProductRegions
Saat operasi melibatkan pemilihan wilayah, AI Agent menggunakan alat ini untuk mengonfirmasi apakah wilayah target mendukung produk tersebut. Misalnya, memasukkan “Can ECS be used in Ulanqab” atau “Create an ECS instance in Singapore” menyebabkan AI Agent terlebih dahulu memverifikasi ketersediaan wilayah.
Panduan Penggunaan
Tentukan nama produk dan wilayah target dalam kueri. Misalnya, “Can ECS be used in Ulanqab” lebih baik daripada “Can it be used in Ulanqab”.
Jika melibatkan beberapa wilayah, sebutkan masing-masing. Contohnya, “Konfirmasikan apakah ECS tersedia di Hangzhou, Shanghai, dan Singapura.”
API Execution
GenerateCLICommand
Saat diminta untuk “hanya menghasilkan perintah tanpa mengeksekusi” atau saat AI Agent perlu melihat pratinjau perintah, alat ini menghasilkan string perintah CLI. AI Agent biasanya terlebih dahulu mengonfirmasi parameter melalui GetApiDefinition, lalu menghasilkan perintah melalui alat ini, dan akhirnya mengeksekusinya melalui CallCLI. Misalnya, memasukkan “Generate a command to query ECS instances in Hangzhou” mengembalikan perintah lengkap yang dapat dieksekusi di terminal lokal.
Panduan Penggunaan
Untuk mengeksekusi perintah secara manual di terminal lokal, mintalah AI Agent untuk “hanya menghasilkan perintah tanpa mengeksekusi.” Perintah yang dihasilkan dapat disalin dan digunakan langsung.
CallCLI
Saat AI Agent mengetahui persis operasi API mana yang harus dieksekusi, alat ini digunakan untuk melakukan pemanggilan langsung. Ini adalah alat utama untuk pemanggilan API di Core Edition. Misalnya, memasukkan “Query running ECS instances in Hangzhou region” menyebabkan AI Agent menyusun perintah CLI dan mengeksekusi kueri tersebut.
Panduan Penggunaan
Perintah CLI yang dieksekusi oleh alat ini berjalan di server jarak jauh dan tidak dapat membaca file lokal.
Operasi penulisan (membuat, mengubah, atau menghapus sumber daya) dapat menimbulkan biaya. Mintalah AI Agent untuk mengonfirmasi isi operasi sebelum eksekusi.
Advanced Orchestration
RunScript
Saat satu pemanggilan API tidak cukup untuk memenuhi kebutuhan, AI Agent menggunakan alat ini untuk menulis skrip guna melakukan operasi batch. Misalnya, memasukkan “Count ECS instances across all regions” atau “Check all security groups for high-risk rules” menyebabkan AI Agent menulis skrip konkuren untuk menanyakan beberapa sumber daya secara bersamaan.
Panduan Penggunaan
Saat diperlukan agregasi, perbandingan, atau operasi batch, jelaskan cakupan dan tujuan secara jelas. Misalnya, “Count ECS instances across all regions” atau “Check all security groups for high-risk rules”.
Eksekusi skrip dapat memakan waktu beberapa detik hingga puluhan detik. Tunggu hasilnya dengan sabar.
GetTask
Saat tugas RunScript atau RunIaC memerlukan waktu lama untuk dieksekusi, AI Agent menggunakan alat ini untuk menunggu penyelesaian tugas dan mengambil hasilnya. Alat ini dapat dipicu selama operasi yang memakan waktu seperti inspeksi lintas wilayah atau penerapan Terraform.
Panduan Penggunaan
Untuk operasi yang memakan waktu (seperti inspeksi lintas wilayah atau kueri batch), tunggu hasilnya dengan sabar.
Jika diperlukan persetujuan manual, selesaikan proses persetujuan sesuai petunjuk dan hasil akan terus dikembalikan.
Infrastructure as Code
GetPresignedUrl
Saat alat RunIaC atau RunScript perlu mereferensikan file eksternal, AI Agent menggunakan alat ini untuk menghasilkan tautan unggah sementara. Misalnya, saat kode Terraform melebihi 64 KB atau skrip perlu memproses file data yang telah diunggah sebelumnya, AI Agent terlebih dahulu mengunggah file melalui alat ini sebelum mengeksekusi operasi selanjutnya.
Panduan Penggunaan
Saat melibatkan unggah file besar, mungkin perlu menunggu unggahan selesai sebelum mengeksekusi operasi selanjutnya.
RunIaC
Saat sumber daya cloud perlu dibuat, dimodifikasi, atau dihapus, AI Agent dapat menggunakan alat ini untuk mengelola infrastruktur melalui Terraform. Misalnya, memasukkan “Create a VPC in Hangzhou with CIDR 172.16.0.0/16” menyebabkan AI Agent terlebih dahulu menghasilkan konfigurasi sumber daya dan meninjau perubahan, lalu mengeksekusi pembuatan setelah dikonfirmasi.
Panduan Penggunaan
Saat menggambarkan kebutuhan sumber daya, tentukan wilayah, spesifikasi, dan penamaan secara jelas. Misalnya, “Create a VPC in Hangzhou with CIDR 172.16.0.0/16, named mcp-demo-vpc”.
Perubahan sumber daya mungkin memerlukan persetujuan manual. Selesaikan proses persetujuan sesuai petunjuk.
Document Search
SearchDocuments
Saat diajukan pertanyaan berbasis pengetahuan tentang penggunaan produk, metode konfigurasi, atau troubleshooting error, AI Agent menggunakan alat ini untuk mencari dokumentasi resmi Alibaba Cloud. Misalnya, memasukkan “How to optimize Function Compute cold start” atau “How to configure OSS Bucket Policy” memicu pencarian dokumen resmi yang sesuai.
Panduan Penggunaan
Menyertakan nama produk dalam kueri meningkatkan relevansi hasil pencarian. Misalnya, “OSS cross-origin configuration” lebih baik daripada “cross-origin configuration”.
Saat diperlukan dokumentasi untuk produk tertentu, sebutkan nama produknya. Misalnya, “Function Compute cold start optimization documentation” lebih baik daripada “cold start optimization”.
GetDocument
Setelah AI Agent menemukan dokumen relevan melalui SearchDocuments, alat ini digunakan untuk membaca konten lengkap guna menjawab pertanyaan. Misalnya, memasukkan “How to optimize Function Compute cold start?” menyebabkan AI Agent terlebih dahulu mencari dan menemukan dokumen, lalu membaca teks lengkap dan menyusun jawaban.
Panduan Penggunaan
AI Agent secara otomatis membaca dan menyusun konten setelah menemukan dokumen. Seluruh proses transparan bagi pengguna.
GetDocumentTree
Saat pengguna ingin memahami struktur dokumentasi suatu produk, AI Agent menggunakan alat ini untuk menelusuri pohon direktori dokumen. Misalnya, memasukkan “What does the OSS documentation structure look like” atau “What user guides does ECS have”.
Panduan Penggunaan
Tentukan nama produk dalam kueri. Misalnya, “What document categories does OSS have” atau “What chapters are under the ECS user guide”.
GrepDocuments
Saat pertanyaan melibatkan istilah spesifik, item konfigurasi, atau kode kesalahan, AI Agent menggunakan alat ini untuk melakukan pencocokan kata kunci eksak dalam dokumentasi produk tertentu. Misalnya, memasukkan “What values does InstanceChargeType have in ECS documentation” atau “Search for CORS-related content in OSS documentation”.
Panduan Penggunaan
Tentukan produk dan kata kunci dalam kueri. Misalnya, “Search for DescribeInstanceAttribute in ECS documentation”.
Kata kunci yang lebih tepat menghasilkan hasil yang lebih relevan. Beberapa kata kunci memiliki hubungan AND.
Kasus Penggunaan Khas
Skenario berikut menunjukkan alur kerja lengkap di mana beberapa alat bekerja sama untuk menyelesaikan tugas kompleks.
Menanyakan Aturan Security Group
Masukan pengguna:
Check the security group rules in the Hangzhou regionRantai pemanggilan alat AI Agent yang mungkin:
Menggunakan
SearchApisuntuk mencari “Query security group rules associated with ECS instances”, menemukan API DescribeSecurityGroupAttribute (confidence 0.98).Menggunakan
GetApiDefinitionuntuk mengonfirmasi bahwa API memerlukan SecurityGroupId dan RegionId sebagai parameter wajib.Menggunakan
CallCLIuntuk mengeksekusi kueri, mengembalikan daftar aturan security group (termasuk arah, protokol, range port, alamat sumber, dll.).
Alat yang terlibat: SearchApis, GetApiDefinition, CallCLI
Inspeksi Batch Cross-Region
Masukan pengguna:
Count the number of ECS instances in Hangzhou, Shanghai, and Beijing regionsRantai pemanggilan alat AI Agent yang mungkin:
Menggunakan
RunScriptuntuk menulis skrip konkuren yang menanyakan jumlah instans di ketiga wilayah secara bersamaan.Eksekusi skrip timeout (melebihi 20 detik), mengembalikan processID.
Menggunakan
GetTaskuntuk memeriksa status tugas dan mengambil hasil setelah eksekusi skrip selesai.
Alat yang terlibat: RunScript, GetTask
Menyelesaikan Masalah Menggunakan Dokumentasi
Masukan pengguna:
Function Compute cold start latency is high. What optimization options are available?Rantai pemanggilan alat AI Agent yang mungkin:
Menggunakan
SearchDocumentsuntuk mencari “Function Compute cold start optimization”, menemukan dokumen “Best Practices for Function Compute Cold Start Optimization” (doc_id: 2513659).Menggunakan
GetDocumentuntuk membaca teks lengkap dokumen dan mengambil definisi cold start serta strategi optimasi.Menggunakan
GetDocumentTreeuntuk menelusuri direktori dokumen Function Compute dan mengidentifikasi bab dokumentasi tambahan terkait kinerja.
Alat yang terlibat: SearchDocuments, GetDocument, GetDocumentTree