Referensi SharePoint (pratinjau)

Note

Artikel ini menjelaskan fitur yang digunakan oleh agen atau alur agen yang didukung oleh standard harness.

Important

Ini adalah fitur pratinjau.

• Microsoft merilis fitur pratinjau sebelum rilis resmi sehingga pelanggan bisa mendapatkan akses awal dan memberikan umpan balik.
• Fitur pratinjau memiliki fungsionalitas terbatas dan tidak dimaksudkan untuk penggunaan produksi.
• Microsoft mungkin mengubah nama dan parameter pratinjau untuk alat MCP. Hindari dependensi yang dikodekan secara permanen. Microsoft mempertahankan dukungan skenario.
• Fitur pratinjau tunduk pada ketentuan penggunaan tambahan Microsoft.

Ikhtisar

ID Server	URL tingkat penyewa	Nama tampilan	Deskripsi
mcp_SharePointRemoteServer	https://agent365.svc.cloud.microsoft/ agents/tenants/{tenantId}/servers/ mcp_SharePointRemoteServer	Sharepoint	Alat untuk operasi SharePoint. Gunakan server ini untuk mengelola situs, daftar, item daftar, kolom, pustaka dokumen, file, folder, dan berbagi file. Operasi file terbatas pada file yang 5 MB atau kurang.

Alat yang tersedia

findSite

Menemukan situs SharePoint yang bisa Anda akses. Mengembalikan situs tertentu yang cocok dengan kueri pencarian, atau 20 situs teratas yang relevan jika Anda tidak menyediakan kueri.

Parameter opsional:

• searchQuery: Kueri pencarian (seluruh atau nama situs parsial). Kosongkan untuk menampilkan 20 situs teratas yang dapat diakses.

getSiteByPath

Menyelesaikan situs SharePoint dengan menggunakan nama host dan jalur relatif server yang tepat. Gunakan metode ini hanya ketika Anda memiliki struktur URL situs lengkap. Gunakan findSite saat Anda hanya mengetahui nama situs.

Parameter yang diperlukan:

• nama host: Nama host yang tepat (misalnya, 'contoso.sharepoint.com')
• serverRelativePath: Jalur relatif terhadap server (misalnya, 'sites/Marketing'). Garis miring awal bersifat opsional.

listSubsites

Mencantumkan semua subsitus (situs anak) dari situs SharePoint.

Parameter yang diperlukan:

• siteId: ID situs SharePoint induk (format: 'hostname,siteCollectionId,webId')

daftarPustakaDokumenDiSitus

Membuat daftar pustaka dokumen (drive) di situs SharePoint yang ditentukan.

Parameter opsional:

• siteId: ID situs SharePoint (default: 'root')

getDefaultDocumentLibraryInSite

Mengambil pustaka dokumen default (drive) di situs SharePoint.

Parameter opsional:

• siteId: ID situs SharePoint (default: 'root')

getFolderChildren

Menghitung 20 file dan folder teratas (DriveItems) yang terkandung dalam folder induk tertentu di pustaka dokumen (drive).

Parameter yang diperlukan:

• documentLibraryId: ID dari pustaka dokumen (drive)

Parameter opsional:

• parentFolderId: ID dari folder induk (bawaan: 'root').

findFileOrFolder

Menemukan file atau folder (DriveItem) yang dapat diakses oleh pengguna dengan kueri pencarian. Pencarian di semua situs dan pustaka dokumen yang dapat diakses pengguna.

Parameter yang diperlukan:

• searchQuery: Kueri pencarian (seluruh atau sebagian nama file)

getFileOrFolderMetadata

Mendapatkan metadata file atau folder (DriveItem) dari pustaka dokumen (drive) tertentu di SharePoint.

Parameter yang diperlukan:

• fileOrFolderId: ID dari file atau folder (DriveItem)
• documentLibraryId: ID dari pustaka dokumen (drive)

getFileOrFolderMetadataByUrl

Mengambil metadata untuk file atau folder (DriveItem) dari URL berbagi. Hanya pengguna dengan izin eksplisit yang ada untuk mengakses file yang bisa mendapatkan metadata.

Parameter yang diperlukan:

• fileOrFolderUrl: URL dari file atau folder. URL tidak ditukarkan untuk membagikannya dengan pengguna; mereka harus sudah memiliki akses eksplisit.

readSmallTextFile

Membaca (mengunduh) file teks yang lebih kecil dari 5 MB dari perpustakaan dokumen tertentu (drive).

Parameter yang diperlukan:

• fileId: ID file (DriveItem) untuk dibaca atau diunduh
• documentLibraryId: ID dari pustaka dokumen (drive)

readSmallBinaryFile

Membaca file biner yang lebih kecil dari 5 MB dari pustaka dokumen (drive) tertentu. Konten file dikembalikan sebagai string yang dikodekan base64.

Parameter yang diperlukan:

• fileId: ID file (DriveItem) untuk dibaca atau diunduh
• documentLibraryId: ID dari pustaka dokumen (drive)

createSmallTextFile

Membuat atau mengunggah file teks yang lebih kecil dari 5 MB ke perpustakaan dokumen tertentu (drive).

Parameter yang diperlukan:

• nama file: Nama file termasuk ekstensi.
• kontenTeks: Isi teks dari file.
• documentLibraryId: ID dari pustaka dokumen (drive)

Parameter opsional:

• parentFolderId: ID folder induk (bawaan: 'root').

createSmallBinaryFile

Membuat file biner yang lebih kecil dari 5 MB dengan mengodekan kontennya dengan base64 ke pustaka dokumen (drive) tertentu.

Parameter yang diperlukan:

• nama file: Nama file termasuk ekstensi.
• base64Content: Konten file biner dikodekan sebagai string base64.
• documentLibraryId: ID dari pustaka dokumen (drive)

Parameter opsional:

• parentFolderId: ID dari folder induk (bawaan: 'root').

createFolder

Membuat folder baru (DriveItem) dalam pustaka dokumen (drive) tertentu. Jika folder dengan nama yang sama ada, sistem menambahkan akhiran numerik (misalnya, NewFolder (1)).

Parameter yang diperlukan:

• folderName: Nama folder
• documentLibraryId: ID dari pustaka dokumen (drive)

Parameter opsional:

• parentFolderId: ID dari folder induk (bawaan: 'root').

ganti namaFileOrFolder

Mengganti nama file atau folder (DriveItem) dalam pustaka dokumen (drive) tertentu. Nama baru harus mematuhi konvensi penamaan.

Parameter yang diperlukan:

• documentLibraryId: ID dari pustaka dokumen (drive)
• fileOrFolderId: ID file atau folder yang akan diganti namanya
• newFileOrFolderName: Nama baru

Parameter opsional:

• etag: ETag untuk kontrol konkurensi

deleteFileOrFolder

Menghapus file atau folder (DriveItem) dari pustaka dokumen (drive) tertentu.

Parameter yang diperlukan:

• documentLibraryId: ID dari pustaka dokumen (drive)
• fileOrFolderId: ID file atau folder yang akan dihapus

Parameter opsional:

• etag: ETag untuk kontrol konkurensi

Pindahkan file atau folder

Memindahkan file atau folder (DriveItem) ke folder tujuan. Mendukung pemindahan antar pustaka dokumen yang berbeda (drive) di dalam SharePoint. Operasi ini asinkron. Gunakan checkOperationStatus untuk memantau kemajuan.

Parameter yang diperlukan:

• sourcedoclibid: ID pustaka dokumen sumber (drive)
• sourcefileid: ID file atau folder sumber yang akan dipindahkan
• destdoclibid: ID pustaka dokumen tujuan (drive)
• destfolderid: ID folder tujuan (harus ada)

Parameter opsional:

• newfilename: Nama baru untuk item yang dipindahkan

salin file atau folder

Menyalin file atau folder (DriveItem) ke folder tujuan. Mendukung penyalinan di berbagai pustaka dokumen dalam SharePoint. Operasi ini asinkron. Gunakan checkOperationStatus untuk memantau kemajuan.

Parameter yang diperlukan:

• sourcedoclibid: ID pustaka dokumen sumber (drive)
• sourcefileid: ID file atau folder sumber yang akan disalin
• destdoclibid: ID pustaka dokumen tujuan (drive)
• destfolderid: ID folder tujuan (harus ada)

Parameter opsional:

• newfilename: Nama baru untuk item yang disalin

checkOperationStatus

Memeriksa status operasi asinkron, seperti salinan atau pemindahan, dengan menggunakan token operasi yang dikembalikan dari operasi asli.

Parameter yang diperlukan:

• operationToken: Token operasi dikembalikan dari operasi asinkron seperti copyFileOrFolder atau moveFileOrFolder

uploadFileFromUrl

Mengunggah file dari URL SharePoint atau OneDrive ke folder tujuan di pustaka dokumen (drive). File disalin dari URL sumber, sehingga file asli tidak diubah.

Parameter yang diperlukan:

• sourceUrl: URL Sumber (harus berupa URL SharePoint atau OneDrive yang valid)
• destinationDocumentLibraryId: ID pustaka dokumen tujuan. Gunakan me untuk OneDrive pengguna

Parameter opsional:

• destinationFolderId: ID folder tujuan (default: root)
• Filename: Nama file baru; default ke nama file asli

shareFileOrFolder

Mengirim undangan berbagi untuk memberikan izin baca atau tulis pada file atau folder (DriveItem) dalam pustaka dokumen (drive) tertentu.

Parameter yang diperlukan:

• documentLibraryId: ID dari pustaka dokumen (drive)
• fileOrFolderId: ID file atau folder yang akan dibagikan
• recipientEmails: Larik alamat email dari penerima
• peran: Larik peran: 'baca', 'tulis' ('tulis' memberikan izin 'baca' dan 'tulis')

Parameter opsional:

• Pesan: Pesan kustom untuk email undangan (default: Berikut file tempat kami berkolaborasi.)
• sendInvitation: Apakah akan mengirim undangan berbagi (default: true)

setSensitivityLabelOnFile

Mengatur label sensitivitas pada file dalam pustaka dokumen (drive) yang ditentukan.

Parameter yang diperlukan:

• documentLibraryId: ID dari pustaka dokumen (drive)
• fileId: ID dari file (DriveItem)
• sensitivityLabelId: ID label sensitivitas, atau string kosong untuk menghapusnya

Parameter opsional:

• assignmentMethod: Metode penugasan: 'standard', 'privileged', 'auto', atau 'unknownFutureValue' (default: 'privileged')
• justificationText: Teks justifikasi untuk tujuan audit; diperlukan saat menurunkan atau menghapus label (default: 'Diubah oleh MCPServer')

listLists

Mendapatkan semua daftar SharePoint tersedia di situs tertentu. Gunakan untuk menemukan daftar apa yang ada dalam situs.

Parameter yang diperlukan:

• siteId: ID situs SharePoint (format: 'hostname,siteCollectionId,webId')

createList

Membuat Daftar SharePoint baru dalam situs.

Parameter yang diperlukan:

• siteId: ID situs SharePoint
• Displayname: Nama tampilan daftar baru

Parameter opsional:

• Kolom: Kumpulan kolom sebagai pasangan kunci-nilai: [{ Key: 'JobTitle', Value: 'text' }]. Jenis yang valid: teks, teks multibaris, angka, boolean, tanggal dan waktu, pilihan, pencarian, orang atau grup, hypertautan, mata uang, terhitung
• template: Jenis templat daftar (bawaan: 'genericList'). Opsi: daftar umum, pustaka dokumen, acara, tugas, pengumuman, kontak, tautan, survei, pelacakan masalah, forum diskusi

deleteList

Menghapus Daftar SharePoint dari situs. Menghapus seluruh kontainer daftar dan semua item di dalamnya. Tindakan ini tidak dapat dibatalkan.

Parameter yang diperlukan:

• siteId: ID situs SharePoint
• listId: ID daftar yang akan dihapus

Parameter opsional:

• etag: ETag untuk kontrol konkurensi

kirim undangan untuk daftar

Mengirim undangan berbagi untuk memberikan izin pada Daftar SharePoint.

Parameter yang diperlukan:

• listId: ID Daftar SharePoint untuk dibagikan
• recipientEmails: Larik alamat email dari penerima
• Peran: Peran: 'baca' (lihat saja), 'kontribusi' (lihat, tambahkan, perbarui, hapus item), 'edit' (edit penuh termasuk struktur daftar)

Parameter opsional:

• siteUrl: URL Situs situs SharePoint yang berisi daftar
• sendEmail: Apakah akan mengirim pemberitahuan email (default: true)

listListItems

Mengambil item (baris/rekaman) dari daftar SharePoint tertentu.

Parameter yang diperlukan:

• siteId: ID situs SharePoint
• listId: ID daftar SharePoint

getListItem

Mengambil satu item (baris atau catatan) dari Daftar SharePoint berdasarkan ID-nya.

Parameter yang diperlukan:

• siteId: ID situs SharePoint
• listId: ID daftar SharePoint
• itemId: ID item daftar tertentu

createListItem

Membuat item baru (baris atau rekaman) dalam Daftar SharePoint.

Parameter yang diperlukan:

• siteId: ID situs SharePoint
• listId: ID daftar SharePoint
• bidang: Pasangan kunci-nilai untuk nilai bidang, seperti [{ Key: 'Title', Value: 'Software Engineer' }, { Key: 'Department', Value: 'Engineering' }]. Kolom 'Judul' biasanya diperlukan.

updateListItem

Memperbarui item yang sudah ada (baris atau rekaman) dalam Daftar SharePoint. Hanya bidang yang ditentukan yang diperbarui; Bidang yang dihilangkan menyimpan nilainya.

Parameter yang diperlukan:

• siteId: ID situs SharePoint
• listId: ID daftar SharePoint
• itemId: ID item yang akan diperbarui
• Kolom: Pasangan kunci-nilai untuk kolom yang akan diperbarui

Parameter opsional:

• etag: ETag untuk kontrol konkurensi

deleteListItem

Menghapus item (baris atau rekaman data) dari daftar SharePoint.

Parameter yang diperlukan:

• siteId: ID situs SharePoint
• listId: ID daftar SharePoint
• itemId: ID item yang akan dihapus

Parameter opsional:

• etag: ETag untuk kontrol konkurensi

listColumns

Mengambil semua kolom dari daftar SharePoint.

Parameter yang diperlukan:

• siteId: ID situs SharePoint
• listId: ID daftar SharePoint

Buat kolom

Membuat kolom baru dalam Daftar SharePoint. Mendukung banyak jenis kolom, termasuk teks, angka, pilihan, tanggal dan waktu, Boolean, pengguna, rujukan, terhitung, dan banyak lagi.

Parameter yang diperlukan:

• siteId: ID situs SharePoint
• listId: ID daftar SharePoint
• Nama: Nama kolom internal (pengidentifikasi terprogram)
• columnType: Jenis kolom: teks, catatan, angka, bilangan bulat, boolean, dateTime, pilihan, multichoice, mata uang, pencarian, pengguna, url, dihitung, istilah, multiterm, lokasi, geolokasi, gambar mini, penghitung, komputasi, contentTypeId, file, lampiran, guid, outcomeChoice, approvalStatus

Parameter opsional:

• columnProperties: Pengaturan khusus jenis (misalnya, { "maxLength": 255 } untuk teks, { "choices": ["A","B","C"] } untuk pilihan)
• Deskripsi: Deskripsi kolom
• Displayname: Nama tampilan ditampilkan di UI (default ke 'nama')
• Diperlukan: Buat kolom diperlukan (default: false)
• Tersembunyi: Sembunyikan kolom dari tampilan (default: false)

updateColumn

Memperbarui kolom yang sudah ada dalam Daftar SharePoint.

Parameter yang diperlukan:

• siteId: ID situs SharePoint
• listId: ID daftar SharePoint
• columnId: ID kolom yang akan diperbarui

Parameter opsional:

• columnType: Jenis kolom (diperlukan saat menyediakan 'columnProperties')
• columnProperties: Properti khusus tipe yang akan diperbarui
• Deskripsi: Deskripsi baru
• Displayname: Nama tampilan baru
• Tersembunyi: Sembunyikan atau perlihatkan kolom
• Diperlukan: Membuat kolom diperlukan atau opsional

Hapus kolom

Menghapus kolom dari Daftar SharePoint. Peringatan: Tindakan ini menghapus semua data yang disimpan di kolom tersebut untuk semua item.

Parameter yang diperlukan:

• siteId: ID situs SharePoint
• listId: ID daftar SharePoint
• columnId: ID kolom yang akan dihapus

Fitur utama

Manajemen situs

• Temukan situs berdasarkan nama atau telusuri situs yang dapat diakses.
• Dapatkan situs dengan jalur URL yang tepat.
• Mencantumkan situs dan subsitus anak.
• Navigasi hierarki situs yang komprehensif.

Manajemen pustaka dokumen

• Mencantumkan semua pustaka dokumen dalam situs.
• Dapatkan pustaka dokumen bawaan.
• Telusuri isi folder (hingga 20 item).
• Membuat dan mengelola struktur folder.

Operasi file

• Buat file teks dan biner (5 MB atau kurang).
• Membaca teks dan file biner (5 MB atau kurang).
• Hapus, ganti nama, dan pindahkan file dan folder.
• Salin file dan folder antar pustaka dokumen.
• Unggah file dari URL SharePoint atau OneDrive.
• Cari file dan folder di semua situs yang dapat diakses.
• Ambil metadata file dan folder.

Operasi asinkron

• Salin dan pindahkan file dan folder secara asinkron di seluruh pustaka dokumen.
• Periksa status operasi asinkron dengan menggunakan token operasi.

Operasi pada daftar

• Membuat, membaca, dan menghapus daftar.
• Dukungan untuk beberapa templat daftar, termasuk generik, pustaka dokumen, peristiwa, dan tugas.
• Bagikan daftar dengan izin berbasis peran.
• Kelola item daftar dengan membuat, membaca, memperbarui, dan menghapusnya.

Manajemen kolom

• Buat kolom dengan berbagai jenis, seperti teks, catatan, angka, boolean, dateTime, pilihan, pencarian, pengguna, URL, dihitung, dan banyak lagi.
• Memperbarui properti kolom dan metadata.
• Mengonfigurasi persyaratan dan visibilitas kolom.
• Atur properti kolom sesuai jenisnya.

Berbagi dan izin

• Berbagi file, folder, dan daftar dengan pengguna.
• Gunakan kontrol akses berbasis peran dengan peran baca, tulis, kontribusi, dan edit.
• Notifikasi email untuk dibagikan.
• Pesan khusus dalam undangan.

Keamanan dan kepatuhan

• Terapkan dan hapus label sensitivitas.
• Gunakan beberapa metode penugasan, termasuk standar, istimewa, dan otomatis.
• Dukungan justifikasi audit.
• Gunakan kontrol konkurensi dengan eTags.

Notes

• Operasi file terbatas pada file yang 5 MB atau kurang untuk diunggah dan diunduh.
• Operasi salin dan pindahkan tidak sinkron. Gunakan checkOperationStatus untuk memantau kemajuan.
• Operasi salin dan pindahkan mendukung operasi lintas pustaka dalam SharePoint.
• uploadFileFromUrl memerlukan URL sumber SharePoint atau OneDrive yang valid.
• eTag menyediakan kontrol konkurensi untuk pembaruan dan penghapusan.
• Akhiran numerik otomatis untuk nama folder duplikat.
• Penghapusan daftar tidak dapat dibatalkan.
• Penghapusan kolom menghapus semua data yang disimpan di kolom tersebut.
• Operasi pencarian mengembalikan 20 hasil teratas secara default.