Referensi SharePoint Work IQ (pratinjau)

Penting

Ini adalah fitur pratinjau.

  • Microsoft merilis ditur pratinjau sebelum rilis resmi agar pelanggan bisa memperoleh akses awal dan memberikan tanggapan.
  • Fitur pratinjau memiliki fungsionalitas yang dibatasi dan tidak dibuat untuk penggunaan produksi.
  • Microsoft mungkin mengubah nama dan parameter alat MCP pratinjau. Hindari dependensi yang dikodekan secara permanen. Microsoft mempertahankan dukungan skenario.
  • Fitur pratinjau bergantung pada Persyaratan 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 Work IQ Server MCP 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 berukuran 5 MB atau kurang.

Alat yang tersedia

findSite

Menemukan situs SharePoint yang dapat Anda akses. Mengembalikan situs tertentu yang sesuai dengan kueri pencarian, atau 20 situs relevan teratas jika Anda tidak memberikan kueri.

Parameter opsional:

  • searchQuery: Kueri pencarian (nama situs lengkap atau sebagian). Biarkan kosong untuk mengembalikan 20 situs teratas yang dapat diakses.

getSiteByPath

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

Parameter wajib:

  • hostname: Nama host yang tepat (misalnya, 'contoso.sharepoint.com')
  • serverRelativePath: Jalur relatif server (misalnya, 'situs/Pemasaran'). Garis miring jarak antar baris bersifat opsional.

listSubsites

Menampilkan semua sub-situs (situs turunan) dari situs SharePoint.

Parameter wajib:

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

listDocumentLibrariesInSite

Menampilkan 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

Mendaftar 20 file dan folder pertama (DriveItems) yang terdapat dalam folder induk tertentu di pustaka dokumen (drive).

Parameter wajib:

  • documentLibraryId: ID pustaka dokumen (drive)

Parameter opsional:

  • parentFolderId: ID folder induk (default: 'root')

findFileOrFolder

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

Parameter wajib:

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

getFileOrFolderMetadata

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

Parameter wajib:

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

getFileOrFolderMetadataByUrl

Mendapatkan metadata file atau folder (DriveItem) dari URL berbagi. Hanya pengguna yang sudah memiliki izin eksplisit untuk mengakses file tersebut yang diizinkan untuk mendapatkan metadata.

Parameter wajib:

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

readSmallTextFile

Membaca (mengunduh) file teks berukuran kurang dari 5 MB dari pustaka dokumen tertentu (drive).

Parameter wajib:

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

readSmallBinaryFile

Membaca file biner berukuran kurang dari 5 MB dari pustaka dokumen tertentu (drive). Konten file dikembalikan dalam bentuk string yang dikodekan base64.

Parameter wajib:

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

createSmallTextFile

Membuat atau mengunggah file teks berukuran kurang dari 5 MB ke pustaka dokumen tertentu (drive).

Parameter wajib:

  • filename: Nama file beserta ekstensi
  • contentText: Isi teks dari file
  • documentLibraryId: ID pustaka dokumen (drive)

Parameter opsional:

  • parentFolderId: ID folder induk (default: 'root')

createSmallBinaryFile

Membuat file biner berukuran di bawah 5 MB dengan mengenkode base64 kontennya ke pustaka dokumen (drive) tertentu.

Parameter wajib:

  • filename: Nama file beserta ekstensi
  • base64Content: Konten file biner yang dienkode sebagai string base64.
  • documentLibraryId: ID pustaka dokumen (drive)

Parameter opsional:

  • parentFolderId: ID folder induk (default: 'root')

createFolder

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

Parameter wajib:

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

Parameter opsional:

  • parentFolderId: ID folder induk (default: 'root')

renameFileOrFolder

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

Parameter wajib:

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

Parameter opsional:

  • etag: ETag untuk kontrol konkurensi

deleteFileOrFolder

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

Parameter wajib:

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

Parameter opsional:

  • etag: ETag untuk kontrol konkurensi

moveFileOrFolder

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

Parameter wajib:

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

Parameter opsional:

  • newfilename: Nama baru untuk item yang dipindahkan

copyFileOrFolder

Menyalin file atau folder (DriveItem) ke folder tujuan. Mendukung penyalinan antar pustaka dokumen yang berbeda dalam SharePoint. Operasi ini asinkron. Gunakan checkOperationStatus untuk memantau progres.

Parameter wajib:

  • sourcedoclibid: ID pustaka dokumen sumber (drive)
  • sourcefileid: ID file sumber atau folder 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 penyalinan atau pemindahan, menggunakan token operasi yang dikembalikan dari operasi asli.

Parameter wajib:

  • operationToken: Token operasi yang 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 wajib:

  • 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; secara default menggunakan nama file asli

shareFileOrFolder

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

Parameter wajib:

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

Parameter opsional:

  • pesan: Pesan khusus untuk email undangan (default: Berikut adalah file yang dikolaborasikan.)
  • sendInvitation: Apakah akan mengirim undangan berbagi (default: benar)

setSensitivityLabelOnFile

Menetapkan label sensitivitas pada file dari pustaka dokumen (drive) yang ditentukan.

Parameter wajib:

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

Parameter opsional:

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

listLists

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

Parameter wajib:

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

createList

Membuat daftar SharePoint baru dalam situs.

Parameter wajib:

  • 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: multilineText, angka, boolean, dateTime, pilihan, lookup, personOrGroup, hyperlink, mata uang, terhitung
  • templat: Jenis templat daftar (default: 'genericList'). Opsi: genericList, documentLibrary, acara, tugas, pengumuman, kontak, tautan, survei, issueTracking, discussionBoard

deleteList

Menghapus daftar SharePoint dari situs. Menghapus seluruh kontainer daftar dan semua item di dalamnya. Tidak dapat dibatalkan.

Parameter wajib:

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

Parameter opsional:

  • etag: ETag untuk kontrol konkurensi

sendInviteForList

Mengirim undangan berbagi untuk memberikan izin pada daftar SharePoint.

Parameter wajib:

  • listId: ID daftar SharePoint untuk dibagikan
  • recipientEmails: Array alamat email dari para penerima
  • peran: Peran: 'baca' (hanya melihat), 'kontribusi' (melihat, menambah, memperbarui, menghapus item), 'edit' (pengeditan penuh termasuk struktur daftar)

Parameter opsional:

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

listListItems

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

Parameter wajib:

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

getListItem

Mendapatkan satu item (baris/rekaman) dari daftar SharePoint berdasarkan ID.

Parameter wajib:

  • siteId: ID situs SharePoint
  • listId: ID dari daftar SharePoint
  • itemId: ID item daftar yang spesifik

createListItem

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

Parameter wajib:

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

updateListItem

Memperbarui item yang ada (baris atau rekaman) dalam daftar SharePoint. Hanya bidang yang disebutkan yang diperbarui; bidang yang tidak disebutkan mempertahankan nilainya.

Parameter wajib:

  • siteId: ID situs SharePoint
  • listId: ID dari daftar SharePoint
  • itemId: ID item yang akan diperbarui
  • bidang: Pasangan kunci-nilai bidang yang akan diperbarui

Parameter opsional:

  • etag: ETag untuk kontrol konkurensi

deleteListItem

Menghapus item (baris atau rekaman) dari daftar SharePoint.

Parameter wajib:

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

Parameter opsional:

  • etag: ETag untuk kontrol konkurensi

listColumns

Mengambil semua kolom dari daftar SharePoint.

Parameter wajib:

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

createColumn

Membuat kolom baru di daftar SharePoint. Mendukung berbagai jenis kolom, termasuk teks, angka, pilihan, tanggalWaktu, boolean, pengguna, lookup, kalkulasi, dan lainnya.

Parameter wajib:

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

Parameter opsional:

  • columnProperties: Setelan khusus tipe: (misalnya, { "maxLength": 255 } untuk teks, { "choices": ["A","B","C"] } untuk pilihan)
  • deskripsi: Deskripsi kolom
  • displayName: Nama tampilan yang muncul di UI (default untuk 'nama')
  • wajib: Menjadikan kolom wajib (default: salah)
  • tersembunyi: Sembunyikan kolom dari tampilan (default: salah)

updateColumn

Memperbarui kolom yang ada dalam daftar SharePoint.

Parameter wajib:

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

Parameter opsional:

  • columnType: Jenis kolom (wajib saat memberikan 'columnProperties')
  • columnProperties: Properti yang spesifik untuk jenis yang akan diperbarui
  • deskripsi: Deskripsi baru
  • displayName: Nama tampilan baru
  • sembunyikan: Menyembunyikan atau menampilkan kolom
  • wajib: Membuat kolom wajib atau opsional

deleteColumn

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

Parameter wajib:

  • siteId: ID situs SharePoint
  • listId: ID dari 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.
  • Daftar situs turunan dan subsitus.
  • Navigasi hierarki situs yang komprehensif.

Manajemen pustaka dokumen

  • Daftar semua pustaka dokumen di situs.
  • Dapatkan pustaka dokumen default.
  • Menelusuri konten folder (hingga 20 item)
  • Membuat dan mengelola struktur folder.

Operasi file

  • Buat file teks dan biner (≤5 MB).
  • Baca file teks dan biner (≤5 MB).
  • 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.
  • Dapatkan metadata file dan folder.

Operasi asinkron

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

Operasi daftar

  • Buat, baca, dan hapus 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 tipe, seperti teks, catatan, angka, boolean, tanggalWaktu, pilihan, lookup, pengguna, URL, dihitung, dan lainnya.
  • Perbarui properti kolom dan metadata.
  • Konfigurasikan persyaratan dan visibilitas kolom.
  • Atur properti kolom sesuai tipe.

Berbagi dan izin

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

Keamanan dan kepatuhan

  • Terapkan dan hapus label sensitivitas.
  • Gunakan beberapa metode penetapan, termasuk standar, hak istimewa, dan otomatis.
  • Mendukung justifikasi audit.
  • Gunakan pengendalian konkurensi dengan eTags.

Catatan

  • Operasi file terbatas pada file yang berukuran 5 MB atau kurang untuk diunggah dan diunduh.
  • Operasi penyalinan dan pemindahan bersifat asinkron. Gunakan checkOperationStatus untuk memantau progres.
  • Operasi salin dan pindahkan mendukung operasi lintas pustaka dalam SharePoint.
  • uploadFileFromUrl memerlukan URL sumber SharePoint atau OneDrive yang valid.
  • eTag memberikan kontrol konkurensi terhadap operasi pembaruan dan penghapusan.
  • Akhiran numerik otomatis untuk nama folder duplikat
  • Penghapusan daftar tidak dapat dibatalkan.
  • Menghapus kolom akan menghapus semua data yang tersimpan di kolom tersebut.
  • Secara default, operasi pencarian mengembalikan 20 hasil teratas.
  • Last updated on