Dokumen ini memandu Anda dalam membuat, men-debug, dan menggunakan plugin kustom untuk mengintegrasikan API yang Anda butuhkan.
Alur Kerja
- Buatplugin: Tentukan informasi dasar plugin.
- Tambahkan tool: Konfigurasikan path API spesifik, parameter permintaan, dan data respons untuk plugin tersebut.
- Debug dan publikasikan: Uji konektivitas API secara online dan publikasikan tool setelah memastikan berfungsi sesuai harapan.
- Gunakan dalam aplikasi: Kaitkan plugin dengan agen dan panggil melalui pengujian percakapan atau integrasi API.
Buat plugin kustom
- Buat plugin kustom
Langkah 1: Buat plugin
- Buka halaman Plugins dan klik Create Plugin.
-
Masukkan informasi plugin.
Jika autentikasi diperlukan, aktifkan sakelar Enable Authentication dan masukkan pengaturan autentikasi.Plug-in Name: Masukkan nama deskriptif. Mendukung bahasa Tiongkok dan Inggris. Contoh: Dormitory Agreement Query Tool Test
Plug-in Description: Jelaskan secara singkat fitur dan tujuan plugin dalam bahasa alami. Deskripsi ini membantu model memutuskan kapan harus menggunakan plugin tersebut. Contoh: Menanyakan konten entri perjanjian asrama tertentu berdasarkan indeks numerik yang dimasukkan.
Plug-in URL: Titik akhir akses plugin. Contoh:https://domitorgreement-plugin-example-icohrkdjxy.cn-beijing.fcapp.run
- Model Studio memperlakukan path berbeda di bawah domain yang sama sebagai API berbeda. Path-path ini sesuai dengan Tool Path yang Anda konfigurasikan saat membuat tool.
-
Tool dalam satu plugin berbagi nama domain yang sama, tetapi masing-masing path tool memetakan ke API unik.
Sebagai contoh, sebuah plugin berisi dua API:
Query: https://xxx.com/query
Delete: https://xxx.com/delete
Pada contoh ini,
https://xxx.comadalah Plug-in URL, sedangkan/querydan/deleteadalah nilai Tool Path. Hal ini menunjukkan bahwa plugin tersebut berisi dua tool.
Parameter autentikasi
Headers (Opsional)
Jika autentikasi diperlukan, Anda dapat mengirimkan informasi autentikasi dalam header kustom.
Enable Authentication (Opsional)
Menentukan apakah aplikasi harus menyediakan autentikasi untuk memanggil plugin kustom Anda. Hal ini bergantung pada kebijakan keamanan penyedia API Anda.
Authentication Type
Terdapat dua metode autentikasi: service-level authentication dan user-level authentication.
Location: Anda dapat menempatkan informasi autentikasi di header permintaan atau string kueri.
Header: Opsi ini menempatkan informasi autentikasi di header
Authorizationpermintaan HTTP, sehingga tidak terlihat di URL.Query: Opsi ini menempatkan informasi autentikasi di URL. Contohnya:
https://example.com?api_key=123456.
Parameter Name: Jika Anda menempatkan informasi autentikasi di string kueri, tentukan nama parameter yang digunakan untuk autentikasi, seperti
api_key. Jika ditempatkan di header, parameter default-nya adalahAuthorization.Type:
basic: Tidak menambahkan awalan apa pun ke token yang Anda berikan.
bearer: Menambahkan awalan
Bearerke token.appcode: Menambahkan awalan
APPCODEke token.
Awalan tersebut disertakan dalam bidang autentikasi. Misalnya, jika Anda memilih
bearer, headerAuthorizationmenjadiAuthorization: Bearer <YOUR_TOKEN>.Token (untuk service-level authentication): Token otentikasi dari penyedia API, seperti Kunci API.
- Setelah formulir selesai diisi, klik Confirm Create Plug-inCreate Tool atau klik Continue to Add Tool.
Langkah 2: Buat tool
-
Masukkan informasi tool, konfigurasikan parameter input dan output, serta definisikan pengaturan lanjutan jika diperlukan.
Pada contoh ini, masukkan "Dormitory Rules Query Tool" untuk Tool Name dan "Menanyakan konten aturan asrama tertentu berdasarkan indeks numerik yang dimasukkan" untuk Tool Description. Atur Tool Path menjadi
/article, pilih POST untuk Request Method, dan pilih application/json untuk Submission Method. Untuk parameter input, atur nama parameter menjadiarticle_index, deskripsi parameter menjadi "index", dan tipe menjadi Number. Parameter ini dikirimkan dalam Body, bersifat wajib, dan metode pengirimannya adalah LLM recognition. Untuk parameter output, atur nama parameter menjadiarticle, deskripsi parameter menjadi "konten aturan asrama", dan tipe menjadi String. Pada pengaturan lanjutan, kueri input pengguna adalah "Tanyakan konten aturan asrama yang sesuai berdasarkan nilai indeks yang dimasukkan", dan nilai parameter inputarticle_indexadalah5.Parameter tool
Informasi Alat
Tool Name
Masukkan nama deskriptif. Mendukung bahasa Tiongkok dan Inggris.
Tool Description
Deskripsi singkat mengenai fitur dan kasus penggunaan tool tersebut.
Hal ini membantu model memutuskan kapan harus memanggil tool. Gunakan bahasa alami dan berikan contoh bila memungkinkan.
Tool Path
Path relatif terhadap Plug-in URL.
Path harus diawali dengan garis miring (
/).Sistem akan menambahkan path ini ke Plug-in URL untuk membentuk URL permintaan lengkap.
Request Method
Pilih GET atau POST sebagai metode permintaan untuk memanggil API.
Submission Method
Tipe encoding untuk badan permintaan.
application/json: Konten badan berupa data berformat JSON.
application/x-www-form-urlencoded: Mengkodekan data formulir sebagai pasangan kunci-nilai.
Metode encoding ini berlaku untuk permintaan POST. Data formulir dikodekan menjadi pasangan kunci-nilai, dipisahkan dengan tanda ampersand (
&), dan kunci dipisahkan dari nilai dengan tanda sama dengan (=). Data kemudian di-URL-encode, yang mengubah karakter khusus menjadi tanda persen (%) diikuti dua digit heksadesimal. Misalnya, spasi dikodekan sebagai%20,&sebagai%26, dan=sebagai%3D.Contoh:
name=John Doe&age=25dikodekan menjadiname=John%20Doe&age=25.
Konfigurasikan parameter input dan output
Configure Input Parameters
Klik Add Input Parameter untuk mengonfigurasi parameter.
Parameter Name: Gunakan nama deskriptif agar model memahami representasi parameter tersebut. Misalnya,
city.Parameter Description: Deskripsi ringkas dan akurat mengenai fungsi parameter input. Hal ini membantu model memahami cara mengambil nilai parameter. Misalnya, untuk parameter bernama
date, Anda dapat menjelaskannya sebagai tanggal dan menentukan formatnya, sepertiyyyy-MM-dd.Type: Tipe data parameter.
Sub-properti tipe
Objecttidak boleh kosong. Klik ikon
di ujung baris objek untuk menambahkan sub-properti.Passing Method: Menentukan cara nilai parameter dikirimkan. Pengaturan ini sangat penting untuk operasi yang benar.
LLM Recognition: Model mengekstraksi nilai parameter dari input pengguna.
Business Pass-through: Sistem meneruskan nilai parameter langsung dari sumber eksternal tanpa pemrosesan atau modifikasi.
Saat Anda memanggil aplikasi menggunakan SDK DashScope atau API HTTP, sistem meneruskan parameter input bertipe
business pass-throughke aplikasi melaluibiz_paramsdanuser_defined_params. Untuk informasi selengkapnya, lihat Pass parameters to an application.
Configure Output Parameters
Klik Add Output Parameters dan konfigurasikan parameter tersebut. Semua parameter bersifat wajib.
Model menggunakan definisi parameter output untuk memfilter dan menyusun ulang respons API berdasarkan kueri pengguna, lalu mengembalikan jawaban akhir.
Seperti parameter input, parameter output harus dijelaskan secara ringkas dan akurat, dengan tingkat nesting minimal.
Metode permintaan GET dan POST sama-sama mendukung tipe
Objectuntuk parameter. Namun, sub-properti tipeObjecttidak boleh kosong. Klik ikon
di ujung baris objek untuk menambahkan sub-properti.Konfigurasi lanjutan (Opsional)
Advanced Configuration
Berikan contoh pemanggilan untuk membantu model menghindari pemanggilan tool yang terlewat atau salah.
Jika parameter input kompleks dan model mungkin salah menyusunnya, memberikan contoh dapat meningkatkan akurasi pemanggilan.
Value: Menentukan parameter pemanggilan yang diharapkan dihasilkan model dari kueri pengguna. Misalnya, untuk input pengguna "Bagaimana cuaca di Hangzhou besok?", parameter yang diharapkan adalah
{"city": "Hangzhou", "date": "2025-04-25"}. - Setelah konfigurasi selesai, klik Save Draft.
-
Debug tool secara online untuk memverifikasi bahwa API dapat dipanggil.
Klik Test Tool. Jika Anda mengaktifkan autentikasi, masukkan informasi autentikasi dan nilai parameter input. Lalu, klik Start Running. Jika eksekusi gagal, sesuaikan konfigurasi berdasarkan pesan error di bagian Run Result dan uji kembali hingga berhasil.
Anda dapat memasukkan nilai parameter input secara manual atau sebagai kode. Untuk parameter kompleks, gunakan Code Editing. Di editor kode, Anda dapat mengirimkan parameter input lengkap berformat JSON beserta nilainya. - Setelah pengujian berhasil, klik Publish. Aplikasi hanya dapat memanggil tool yang telah Published.
Gunakan plugin
- Konsol
- API
-
Metode 1: Publikasikan plugin sebagai layanan MCP, lalu tambahkan layanan tersebut ke aplikasi agen.
Langkah 1: Publikasikan plugin sebagai layanan MCP
-
Di halaman Plugins, arahkan kursor ke kartu plugin target dan klik Publish as MCP Service.
Jika plugin telah dikonversi menjadi layanan MCP, tombol berubah menjadi View MCP Service. Klik untuk membuka halaman Manajemen MCP dan melihat detail layanan.
- Setelah berhasil dipublikasikan, Anda dapat melihat detail layanan MCP di halaman MCP Management, termasuk nama layanan, deskripsi, dan ID.
- Buka kanvas orkestrasi aplikasi Agent Application. Di blok MCP, klik +.
-
Di panel Select MCP Service, beralih ke tab Custom MCPS, temukan layanan MCP yang dikonversi dari plugin, lalu klik Add All untuk menambahkannya ke aplikasi.
Anda juga dapat mengklik Convert from Plugin to MCP untuk langsung mempublikasikan plugin yang belum dikonversi.
-
Uji apakah plugin berfungsi sesuai harapan.
- Tanpa autentikasi: Lakukan percakapan dengan model di kotak input untuk menguji fungsionalitas plugin.
user-level authenticationatauservice-level authentication: Sebelum memulai percakapan, klik
untuk mengonfigurasi token otentikasi. Anda hanya perlu mengonfigurasi token sekali per sesi di halaman ini.- Jika Passing Method untuk parameter input tool diatur ke Business Pass-through, Anda harus mengklik
untuk mengonfigurasi nilai variabel sebelum memulai percakapan. Anda hanya perlu memasukkan nilai sekali per sesi di halaman ini.
- Setelah pengujian selesai, Publish aplikasi tersebut.
-
Di halaman Plugins, arahkan kursor ke kartu plugin target dan klik Publish as MCP Service.
- Metode 2: Di halaman Application Management, buka kanvas orkestrasi untuk aplikasi Agent Application Anda, tambahkan layanan MCP dari blok MCP, uji fungsionalitasnya, lalu Publish aplikasi tersebut.
Kelola plugin dan tool
Hapus plugin
Hapus plugin
Edit plugin
Edit plugin
- Di daftar Plugins, temukan plugin target dan klik View Details.
- Di pojok kanan atas, klik Modify Plug-in, ubah informasi plugin, lalu simpan perubahan. Perubahan berlaku segera. Jika Anda mengubah URL plugin, header, atau informasi autentikasi, pemanggilan tool mungkin gagal. Anda harus menguji dan mempublikasikan ulang tool tersebut.
Ubah alat
Ubah alat
- Di daftar Plugins, temukan plugin yang berisi tool tersebut dan klik View Details.
- Di baris yang berisi tool tersebut, klik Modify, ubah informasi tool, lalu klik Save Draft.
- Klik Test Tool untuk men-debug tool secara online.
- Setelah eksekusi berhasil, klik Publish.
Hapus tool
Hapus tool
- Di daftar Plugins, temukan plugin yang berisi tool tersebut dan klik View Details.
- Di baris yang berisi tool tersebut, klik Delete.
Kode error
Tabel berikut menjelaskan pesan error umum yang dapat terjadi saat Anda mempublikasikan tool.
Kode error | Pesan error | Deskripsi |
|---|---|---|
130040 | Deskripsi parameter untuk xx tidak ada. | Penyebab: Deskripsi untuk parameter Solusi: Tambahkan deskripsi parameter dan publikasikan ulang tool tersebut. |
130022 | Gagal menyimpan informasi tool. Periksa apakah parameter contoh sudah benar. | Kemungkinan penyebab 1: Parameter input atau output bertipe Solusi: Klik ikon Kemungkinan penyebab 2: Metode permintaan adalah GET, tetapi parameter input bertipe Solusi: Permintaan GET tidak mendukung tipe |
di samping nama tool.
untuk menyalin ID tool.