SharePoint 參考資料(預覽)

Note

本文描述由 標準線束驅動的代理或代理流程中使用的功能。

Important

這是預覽功能。

  • Microsoft 會在正式發行前釋出預覽功能,讓客戶能搶先體驗並提供回饋。
  • 預覽功能功能有限,且不適合生產環境使用。
  • Microsoft 可能會更改預覽版 MCP 工具名稱和參數。 避免硬編碼的相依關係。 Microsoft 維持情境支援。
  • 預覽功能須遵守Microsoft補充使用條款。

Note

針對特定應用程式的 Microsoft 365 MCP 工具(Copilot、行事曆、郵件、SharePoint、OneDrive、Teams、User 和 Word)僅用於向下相容,不應用於生產環境或新專案。 對於需要存取 Microsoft 365 資源的新專案,請使用 Work IQ MCP 搭配 Microsoft Copilot 工具。 欲了解更多資訊,請參閱 Copilot Studio 中的 Work IQ MCP。

Overview

使用此參考資料查詢代理程式與代理程式流程搭配標準架構所使用的舊版 SharePoint 模型情境協定(MCP)伺服器的工具與參數。 這些工具與 Work IQ 是分開的。

伺服器識別碼 租戶層級 URL 顯示名稱 Description
mcp_SharePointRemoteServer https://agent365.svc.cloud.microsoft/agents/tenants/{tenantId}/servers/mcp_SharePointRemoteServer SharePoint SharePoint 操作工具。 使用此伺服器管理網站、清單、清單項目、欄位、文件庫、檔案、資料夾及檔案分享。 檔案操作限制於 5 MB 或以下的檔案。

請在租戶層級 URL 中,將 {tenantId} 替換為您的 Microsoft Entra 租戶 ID。

可用工具

findSite

找到你可以存取的 SharePoint 網站。 回傳符合搜尋查詢的特定網站,或若未提供查詢,則回傳前20名相關網站。

選擇性參數:

  • 搜尋查詢: 搜尋查詢(完整或部分網站名稱)。 省略返回前20名可及網站。

getSiteByPath

透過精確的主機名稱和伺服器相對路徑來解決 SharePoint 網站的問題。 只有在你擁有完整網站網址結構後才使用此方法。 當你只知道一個網站名稱時使用 findSite 。

必要參數:

  • 主機名稱: 精確主機名稱(例如,'contoso.sharepoint.com')
  • serverRelativePath: 伺服器相對路徑(例如「sites/Marketing」)。 前導斜線可省略。

列出子網站

列出 SharePoint 網站的所有子站(子站點)。

必要參數:

  • siteID:父 SharePoint 網站的 ID(格式:'hostname, siteCollectionId, webId')

listDocumentLibrariesInSite

在指定的 SharePoint 網站上列出文件庫(磁碟機)。

選擇性參數:

  • siteId:SharePoint 網站的 ID(預設:「root」)

getDefaultDocumentLibraryInSite

取得 SharePoint 網站中的預設文件庫(磁碟機)。

選擇性參數:

  • siteId:SharePoint 網站的 ID(預設:「root」)

getFolderChildren

列舉文件函式庫(磁碟)中指定父資料夾內的前20個檔案與資料夾(DriveItems)。

必要參數:

  • documentLibraryId: 文件庫(磁碟機)的 ID。

選擇性參數:

  • parentFolderId: 父資料夾的 ID(預設:「root」)。

尋找檔案或資料夾

透過搜尋查詢找到使用者可存取的檔案或資料夾(DriveItem)。 搜尋使用者可存取的所有網站和文件庫。

必要參數:

  • 搜尋查詢: 搜尋查詢(完整或部分檔案名稱)

getFileOrFolderMetadata(取得檔案或資料夾的中繼資料)

從 SharePoint 中指定的文件庫(磁碟)取得檔案或資料夾(DriveItem)的元資料。

必要參數:

  • fileOrFolderId: 檔案或資料夾的 ID(DriveItem)
  • documentLibraryId: 文件庫(磁碟機)的 ID。

获取文件或資料夾的元數據透過URL

從分享網址取得檔案或資料夾(DriveItem)的元資料。 只有擁有明確存取檔案權限的使用者才能取得中繼資料。

必要參數:

  • fileOrFolderUrl: 檔案或資料夾的網址。 網址不會被兌換來分享給使用者;他們必須已經有明確的存取權限。

readSmallTextFile

從特定文件庫(磁碟機)讀取(下載)小於 5 MB 的文字檔。

必要參數:

  • fileID: 用於讀取或下載的檔案 ID(DriveItem)
  • documentLibraryId: 文件庫(磁碟機)的 ID。

readSmallBinaryFile

從特定文件庫(磁碟機)讀取小於 5 MB 的二進位檔案。 檔案內容會傳回為 base64 編碼的字串。

必要參數:

  • fileID: 用於讀取或下載的檔案 ID(DriveItem)
  • documentLibraryId: 文件庫(磁碟機)的 ID。

createSmallTextFile

建立或上傳小於 5 MB 的文字檔到特定文件庫(磁碟機)。

必要參數:

  • 檔名: 檔案名稱,包含副檔名。
  • contentText: 檔案的文字內容。
  • documentLibraryId: 文件庫(磁碟機)的 ID。

選擇性參數:

  • parentFolderId: 父資料夾的 ID(預設:「root」)。

createSmallBinaryFile

在特定文件庫(磁碟機)中建立小於 5 MB 的二進位檔案。 請在 base64Content 中以 base64 編碼的字串提供檔案內容。

必要參數:

  • 檔名: 檔案名稱,包含副檔名。
  • base64Content: 以 base64 字串編碼的二進位檔案內容。
  • documentLibraryId: 文件庫(磁碟機)的 ID。

選擇性參數:

  • parentFolderId: 父資料夾的 ID(預設:「root」)。

創建資料夾

在指定的文件庫(磁碟)中建立一個新資料夾(DriveItem)。 若存在同名資料夾,系統會加上數字後綴(例如 NewFolder (1))。

必要參數:

  • 資料夾名稱: 資料夾的名稱
  • documentLibraryId: 文件庫(磁碟機)的 ID。

選擇性參數:

  • parentFolderId: 父資料夾的 ID(預設:「root」)。

renameFileOrFolder(重新命名檔案或資料夾)

在指定的文件庫(磁碟)中重新命名檔案或資料夾(DriveItem)。 新名稱必須遵守命名慣例。

必要參數:

  • documentLibraryId: 文件庫(磁碟機)的 ID。
  • fileOrFolderId: 要重新命名的檔案或資料夾的 ID
  • newFileOrFolderName: 新名稱

選擇性參數:

  • etag: ETag 用於並發控制

刪除檔案或資料夾

從指定的文件庫(磁碟)中刪除檔案或資料夾(DriveItem)。

必要參數:

  • documentLibraryId: 文件庫(磁碟機)的 ID。
  • fileOrFolderId: 要刪除的檔案或資料夾的 ID

選擇性參數:

  • etag: ETag 用於並發控制

移動檔案或資料夾

將檔案或資料夾(DriveItem)移至目的地資料夾。 支援在 SharePoint 內跨越不同的文件庫(磁碟機)。 此操作為非同步。 用 checkOperationStatus 來監測進度。

必要參數:

  • sourcedoclibid: 原始文件庫(磁碟機)的識別碼
  • sourcefileID: 要移動的來源檔案或資料夾的 ID
  • destdoclibid: 目的文件庫(磁碟機)的識別碼
  • DestFolderID: 目的地資料夾的 ID(必須存在)

選擇性參數:

  • newfilename: 移動項目的新名稱

複製檔案或資料夾

將檔案或資料夾(DriveItem)複製到目的地資料夾。 支援在 SharePoint 內跨不同文件庫複製。 此操作為非同步。 用 checkOperationStatus 來監測進度。

必要參數:

  • sourcedoclibid: 原始文件庫(磁碟機)的識別碼
  • sourcefileid: 要複製的來源檔案或資料夾的 ID
  • destdoclibid: 目的文件庫(磁碟機)的識別碼
  • DestFolderID: 目的地資料夾的 ID(必須存在)

選擇性參數:

  • 新檔名: 複製項目的新名稱

檢查操作狀態

透過從原始操作回傳的操作標記來檢查非同步操作(如複製或移動)的狀態。

必要參數:

  • operationToken: 非同步作業(如 copyFileOrFolder 或 moveFileOrFolder)傳回的操作權杖

從網址上傳檔案

將檔案從 SharePoint 或 OneDrive URL 上傳到文件庫(磁碟)中的目標資料夾。 檔案是從原始網址複製的,因此原始檔案不會被更改。

必要參數:

  • sourceUrl:來源網址(必須是有效的 SharePoint 或 OneDrive URL)
  • destinationDocumentLibraryId: 目的地文件庫的 ID。 使用 me 表示使用者的 OneDrive

選擇性參數:

  • destinationFolderId: 目的地資料夾的 ID(預設: root)
  • 檔名: 新檔名;預設為原始檔名

共用檔案或資料夾

發送分享邀請,授予指定文件庫(磁碟)內檔案或資料夾(DriveItem)的讀寫權限。

必要參數:

  • documentLibraryId: 文件庫(磁碟機)的 ID。
  • fileOrFolderId: 要分享的檔案或資料夾的 ID
  • recipientEmails: 收件人電子郵件地址陣列
  • 角色: 角色陣列:『read』、『write』(寫入同時賦予讀取與寫入權限)

選擇性參數:

  • 訊息: 邀請電子郵件的自訂訊息(預設:這是我們正在協作的檔案。)
  • 發送邀請: 是否發送分享邀請(預設:true)

文件設置敏感性標籤 (setSensitivityLabelOnFile)

設定指定文件庫(磁碟機)檔案的敏感性標籤。

必要參數:

  • documentLibraryId: 文件庫(磁碟機)的 ID。
  • fileID: 檔案 ID(DriveItem)
  • sensitivityLabelId: 敏感標籤的 ID,或空字串以移除它

選擇性參數:

  • assignmentMethod: 分配方法:'standard', 'privileged', 'auto' 或 'unknownFutureValue'(預設為'privileged')
  • justificationText: 用於稽核目的的理由說明文字;在降級或移除標籤時為必填(預設:'Changed by MCPServer')

列表列表

取得特定網站上所有可用的 SharePoint 清單。 用來了解網站上有哪些清單。

必要參數:

  • siteID:SharePoint 網站的 ID(格式:'hostname, siteCollectionId, webId')

createList

在網站中建立新的 SharePoint 清單。

必要參數:

  • siteId:SharePoint 網站的識別碼
  • displayName: 新清單的顯示名稱

選擇性參數:

  • 欄位: 欄位作為鍵值對的集合: [{ Key: 'JobTitle', Value: 'text' }]。 有效類型:文字、多行文字、數字、布林值、日期時間、選項、查閱、人員或群組、超連結、貨幣、計算欄位
  • 範本: 清單範本類型(預設:'genericList')。 選項:一般清單、文件庫、事件、任務、公告、聯絡人、連結、問卷調查、問題追蹤、討論區

刪除清單

從網站刪除 SharePoint 清單。 刪除整個清單容器及其內所有項目。 這個行動無法撤銷。

必要參數:

  • siteId:SharePoint 網站的識別碼
  • listId: 要刪除清單的 ID

選擇性參數:

  • etag: ETag 用於並發控制

傳送列表邀請

傳送分享邀請,以授與 SharePoint 清單的權限。

必要參數:

  • listId:要分享的 SharePoint list 的 ID
  • 收件人電子郵件: 收件人電子郵件地址陣列
  • 角色: 角色:'read'(僅檢視)、'contribute'(檢視、新增、更新、刪除項目)、'edit'(完整編輯,包含清單結構)

選擇性參數:

  • siteUrl:包含該清單的 SharePoint 網站網址
  • sendEmail: 是否要發送電子郵件通知(預設:true)

列表列表項目

從特定的 SharePoint list 取得項目(列/記錄)。

必要參數:

  • siteId:SharePoint 網站的識別碼
  • listId:SharePoint list 的 ID

getListItem

從 SharePoint list 中透過 ID 取得單一項目(列或紀錄)。

必要參數:

  • siteId:SharePoint 網站的識別碼
  • listId:SharePoint list 的 ID
  • itemId: 特定清單項目的識別碼

建立清單項目

在 SharePoint list 中建立一個新的項目(列或記錄)。

必要參數:

  • siteId:SharePoint 網站的識別碼
  • listId:SharePoint list 的 ID
  • 欄位: 欄位值的鍵值對,例如 [{ Key: 'Title', Value: 'Software Engineer' }, { Key: 'Department', Value: 'Engineering' }]。 通常需要填寫「標題」欄位。

更新清單項目

更新 SharePoint list 中現有的項目(列或記錄)。 只有指定的欄位會被更新;省略欄位則保留其值。

必要參數:

  • siteId:SharePoint 網站的識別碼
  • listId:SharePoint list 的 ID
  • itemId: 要更新的項目ID
  • 欄位: 需要更新的欄位的鍵值對

選擇性參數:

  • etag: ETag 用於並發控制

deleteListItem

從 SharePoint list 刪除一個項目(列或紀錄)。

必要參數:

  • siteId:SharePoint 網站的識別碼
  • listId:SharePoint list 的 ID
  • itemId: 要刪除的項目ID

選擇性參數:

  • etag: ETag 用於並發控制

列出欄位

從 SharePoint 清單中取得所有欄位。

必要參數:

  • siteId:SharePoint 網站的識別碼
  • listId:SharePoint list 的 ID

創建欄位

在 SharePoint list 中建立一個新欄位。 支援多種欄位類型,包括文字、數字、選擇、dateTime、布林值、使用者、查詢、計算等。

必要參數:

  • siteId:SharePoint 網站的識別碼
  • listId:SharePoint list 的 ID
  • 名稱: 內部欄位名稱(程式識別碼)
  • columnType: 欄位類型:text、note、number、integer、boolean、dateTime、choice、multichoice、currency、lookup、user、url、calculated、term、multiterm、location、geolocation、thumbnail、counter、computed、contentTypeId、file、attachment、guid、outcomeChoice、approvalStatus

選擇性參數:

  • columnProperties: 類型專屬設定(例如,{ "maxLength": 255 } 用於文字,{ "choices": ["A","B","C"] } 用於選擇)
  • 描述: 欄位描述
  • displayName: 顯示名稱在使用者介面中顯示(預設為「name」)
  • required: 將欄位設為必填(預設:false)
  • 隱藏: 在檢視中隱藏欄位(預設:false)

更新欄位

更新 SharePoint list 中現有的欄位。

必要參數:

  • siteId:SharePoint 網站的識別碼
  • listId:SharePoint list 的 ID
  • columnId: 要更新的欄位ID

選擇性參數:

  • columnType: 欄位類型(提供 columnPropertiess 時必須)
  • columnProperties: 要更新的類型特定屬性
  • 描述: 新描述
  • 顯示名稱: 新的顯示名稱
  • 隱藏: 隱藏或顯示欄位
  • 必填: 將欄設為必填或選填

刪除欄

從 SharePoint 清單刪除欄。 警告: 此動作會移除所有項目在該欄位中儲存的所有資料。

必要參數:

  • siteId:SharePoint 網站的識別碼
  • listId:SharePoint list 的 ID
  • columnID: 要刪除的欄位 ID

關鍵功能

場地管理

  • 依名稱搜尋網站或瀏覽可取得的網站。
  • 以確切 URL 路徑取得網站。
  • 列出下層網站與子網站。
  • 完整的網站階層導航。

文件庫管理

  • 列出網站上所有的文件庫。
  • 取得預設的文件庫。
  • 瀏覽資料夾內容(最多20個項目)。
  • 建立並管理資料夾結構。

檔案操作

  • 建立文字與二進位檔案(5 MB 或以下)。
  • 閱讀文字和二進位檔案(5 MB 或以下)。
  • 刪除、重新命名並移動檔案和資料夾。
  • 在文件庫間複製檔案和資料夾。
  • 從 SharePoint 或 OneDrive 網址上傳檔案。
  • 在所有可存取的網站上搜尋檔案和資料夾。
  • 取得檔案和資料夾的元資料。

非同步作業

  • 可非同步複製並移動檔案與資料夾於文件庫間。
  • 透過使用操作標記來檢查非同步操作的狀態。

操作列表

  • 建立、閱讀和刪除清單。
  • 支援多種清單範本,包括通用、文件庫、事件及任務。
  • 分享以角色為基礎權限的清單。
  • 透過建立、閱讀、更新和刪除清單來管理清單項目。

欄位管理

  • 建立多種類型的欄位,例如文字、筆記、數字、布林值、日期時間、選擇、查詢、使用者、URL、計算等。
  • 更新欄位屬性與元資料。
  • 設定欄位需求與可見性。
  • 設定特定類型的欄位屬性。

共用和權限

  • 與使用者分享檔案、資料夾和清單。
  • 使用基於角色的存取控制,包含讀取、寫入、貢獻和編輯角色。
  • 電子郵件通知以供分享。
  • 邀請函中的自訂訊息。

安全性與合規性

  • 貼上和移除敏感標籤。
  • 使用多種指派方法,包括標準、特權和自動。
  • 支持審計的合理性。
  • 使用 ETag 進行並行存取控制。

Notes

  • 檔案操作僅限於上傳與下載時大小不超過 5 MB 的檔案。
  • 複製與移動操作是非同步的。 用 checkOperationStatus 來監測進度。
  • 複製與移動操作支援 SharePoint 內的跨函式庫操作。
  • uploadFileFromUrl需要有效的 SharePoint 或 OneDrive 原始網址。
  • eTag 提供更新與刪除的並行控制。
  • 重複資料夾名稱自動加上數字後綴。
  • 清單刪除無法撤銷。
  • 欄位刪除會移除該欄位中儲存的所有資料。
  • findSite 當您省略 searchQuery時,會回傳前 20 個相關網站。
  • getFolderChildren 回傳指定父資料夾中排名前 20 的檔案與資料夾。