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 harness。 更多信息请参见 Copilot Studio 中的 Work IQ MCP。

Overview

使用此参考查找适用于传统 SharePoint 模型上下文协议(MCP)服务器的工具和参数,这些服务器是代理和代理流通过标准框架使用的。 这些工具与 Work IQ 是分开的。

服务器 ID 租户级 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 站点。 仅当具有完整的网站 URL 结构时,才使用此方法。 仅知道网站名称时使用 findSite 。

所需参数:

  • 主机名: 确切的主机名(例如,“contoso.sharepoint.com”)
  • serverRelativePath: 服务器相对路径(例如,“sites/Marketing”)。 列表开头的斜杠是可选的。

listSubsites

列出SharePoint网站的所有子网站(子网站)。

所需参数:

  • siteId:父级 SharePoint 站点的 ID(格式:'hostname,siteCollectionId,webId')

列出网站中的文档库

列出指定SharePoint网站中的文档库(驱动器)。

可选参数:

  • siteId:SharePoint 站点的 ID(默认:'root')

获取站点中的默认文档库

获取SharePoint网站中的默认文档库(驱动器)。

可选参数:

  • siteId:SharePoint 站点的 ID(默认:'root')

getFolderChildren

枚举文档库(驱动器)中指定父文件夹中包含的前 20 个文件和文件夹(DriveItems)。

所需参数:

  • documentLibraryId: 文档库(驱动器)的 ID。

可选参数:

  • parentFolderId: 父文件夹的 ID(默认:“root”)。

findFileOrFolder

通过搜索查询查找用户可访问的文件或文件夹(DriveItem)。 搜索用户有权访问的所有网站和文档库。

所需参数:

  • 搜索查询: 搜索查询(完整或部分文件名)

获取文件或文件夹元数据

从SharePoint中的指定文档库(drive)获取文件或文件夹(DriveItem)的元数据。

所需参数:

  • fileOrFolderId: 文件或文件夹的ID(DriveItem)
  • documentLibraryId: 文档库(驱动器)的 ID。

getFileOrFolderMetadataByUrl(获取文件或文件夹元数据通过网址)

从共享URL获取文件或文件夹(DriveItem)的元数据。 只有具有访问文件的现有显式权限的用户才能获取元数据。

所需参数:

  • fileOrFolderUrl: 文件或文件夹的URL。 不能通过兑换该 URL 来与用户共享;用户必须已具有显式访问权限。

readSmallTextFile

读取(下载)一个小于5 MB的文本文件,来自特定的文档库(驱动器)。

所需参数:

  • fileID: 用于读取或下载的文件(DriveItem)的ID。
  • documentLibraryId: 文档库(驱动器)的 ID。

readSmallBinaryFile

从特定文档库(驱动器)读取小于 5 MB 的二进制文件。 文件内容以 base64 编码的字符串的形式返回。

所需参数:

  • fileID: 用于读取或下载的文件(DriveItem)的ID。
  • documentLibraryId: 文档库(驱动器)的 ID。

创建小型文本文件

创建或上传小于5MB的文本文件到特定的文档库(驱动器)。

所需参数:

  • 文件名: 文件名称,包括扩展名。
  • contentText: 文件的文本内容。
  • documentLibraryId: 文档库(驱动器)的 ID。

可选参数:

  • parentFolderId: 父文件夹的 ID(默认:“root”)。

创建小型二进制文件

在特定文档库(驱动器)中创建一个小于 5 MB 的二进制文件。 请在base64Content中以 base64 编码的字符串形式提供文件内容。

所需参数:

  • 文件名: 文件名称,包括扩展名。
  • base64Content: 以 base64 字符串编码的二进制文件内容。
  • documentLibraryId: 文档库(驱动器)的 ID。

可选参数:

  • parentFolderId: 父文件夹的 ID(默认:“root”)。

创建文件夹

在指定的文档库(驱动器)内创建新文件夹(DriveItem)。 如果存在同名的文件夹,系统将添加数字后缀(例如 NewFolder (1) 。

所需参数:

  • 文件夹名称: 文件夹的名称
  • documentLibraryId: 文档库(驱动器)的 ID。

可选参数:

  • parentFolderId: 父文件夹的 ID(默认:“root”)。

文件或文件夹重命名

重命名指定文档库(驱动器)中的文件或文件夹(DriveItem)。 新名称必须符合命名约定。

所需参数:

  • documentLibraryId: 文档库(驱动器)的 ID。
  • fileOrFolderId: 要重命名的文件或文件夹的ID
  • newFileOrFolderName: 新名称

可选参数:

  • etag: ETag 用于并发控制

deleteFileOrFolder (删除文件或文件夹)

从指定的文档库(驱动器)中删除文件或文件夹(DriveItem)。

所需参数:

  • documentLibraryId: 文档库(驱动器)的 ID。
  • fileOrFolderId: 要删除的文件或文件夹的ID

可选参数:

  • etag: ETag 用于并发控制

移动文件或文件夹

将文件或文件夹(DriveItem)移动到目标文件夹。 支持在SharePoint中跨不同的文档库(驱动器)移动。 此操作为异步操作。 使用 checkOperationStatus 来监控进度。

所需参数:

  • sourcedoclibid: 源文档库(驱动器)的 ID。
  • sourcefileID: 要移动的源文件或文件夹的ID
  • destdoclibid: 目标文档库(驱动器)的 ID
  • destfolderID: 目标文件夹的ID(必须存在)

可选参数:

  • newfilename: 移动物品的新名称

复制文件或文件夹 (copyFileOrFolder)

将文件或文件夹(DriveItem)复制到目标文件夹。 支持跨 SharePoint 中的不同文档库进行复制。 此操作为异步操作。 使用 checkOperationStatus 来监控进度。

所需参数:

  • sourcedoclibid: 源文档库(驱动器)的 ID。
  • SourcefileID: 要复制的源文件或文件夹的ID
  • destdoclibid: 目标文档库(驱动器)的 ID
  • destfolderID: 目标文件夹的ID(必须存在)

可选参数:

  • newfilename: 复制项目的新名称

checkOperationStatus

使用从原始操作返回的操作令牌检查异步操作的状态,例如复制或移动。

所需参数:

  • 操作令牌: 操作令牌来自异步操作,如 copyFileOrFolder 或 moveFileOrFolder

从URL上传文件

将文件从SharePoint或OneDrive URL 上传到文档库(驱动器)中的目标文件夹。 该文件是从源 URL 复制的,因此不会更改原始文件。

所需参数:

  • sourceUrl:源 URL(必须是有效的 SharePoint 或 OneDrive URL)
  • destinationDocumentLibraryId: 目的文档库的ID。 对用户的OneDrive使用 me

可选参数:

  • destinationFolderId: 目标文件夹的ID(默认: root)
  • 文件名: 新文件名;默认使用原始文件名

共享文件或文件夹 (shareFileOrFolder)

发送共享邀请,以授予对指定文档库(drive)中的文件或文件夹(DriveItem)的读取或写入权限。

所需参数:

  • documentLibraryId: 文档库(驱动器)的 ID。
  • fileOrFolderId: 要分享的文件或文件夹的ID
  • 收件人电子邮件: 收件人电子邮件地址的数组
  • 角色: 角色数组:'read'、'write'(write同时赋予读和写)

可选参数:

  • 消息: 邀请邮件的自定义消息(默认:这是我们正在合作处理的文件。)
  • 发送邀请: 是否发送分享邀请(默认:true)

在文件上设置敏感性标签

设置指定文档库(驱动器)中文件的敏感度标签。

所需参数:

  • documentLibraryId: 文档库(驱动器)的 ID。
  • fileId: 文件 ID(DriveItem)
  • sensitivityLabelId: 敏感标签的ID,或用于移除的空字符串

可选参数:

  • assignmentMethod: 分配方法:'standard'、'privileged'、'auto' 或 'unknownFutureValue'(默认:'privileged')
  • justificationText: 用于审计目的的理由文本;在降级或移除标签时为必填(默认:'由MCPServer更改')

列出列表

获取特定网站上可用的所有SharePoint列表。 用于发现网站中存在哪些列表。

所需参数:

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

createList

在站点内创建新的 SharePoint 列表。

所需参数:

  • siteId:SharePoint 网站的 ID
  • displayName: 新列表的显示名称

可选参数:

  • 列: 列作为键值对的集合: [{ Key: 'JobTitle', Value: 'text' }]。 有效类型:text、multilineText、number、boolean、dateTime、choice、lookup、personOrGroup、hyperlink、currency、calculated
  • 模板: 列表模板类型(默认:“genericList”)。 选项:通用列表、文档库、事件、任务、公告、联系人、链接、调查、问题追踪、讨论板

deleteList

从网站删除 SharePoint 列表。 删除整个列表容器及其中的所有项。 此操作不能撤消。

所需参数:

  • siteId:SharePoint 网站的 ID
  • listId: 要删除列表的ID

可选参数:

  • etag: ETag 用于并发控制

发送列表邀请

发送共享邀请以授予对 SharePoint 列表的权限。

所需参数:

  • listId:用于共享的 SharePoint list 的 ID
  • 收件人电子邮件: 收件人电子邮件地址的数组
  • 角色: 角色:'read'(仅限查看)、'contribute'(查看、添加、更新、删除项目)、'edit'(包括列表结构的完整编辑)

可选参数:

  • siteUrl:包含该列表的 SharePoint 网站的网站 URL
  • 发送邮件: 是否发送电子邮件通知(默认:true)

listListItems

从特定的 SharePoint 列表中获取项(行/记录)。

所需参数:

  • siteId:SharePoint 网站的 ID
  • listId:SharePoint list 的 ID

获取列表项

通过其 ID 从 SharePoint 列表中获取单个项(行或记录)。

所需参数:

  • siteId:SharePoint 网站的 ID
  • listId:SharePoint list 的 ID
  • itemId: 具体列表项目的ID

createListItem

在SharePoint list中创建新项(行或记录)。

所需参数:

  • siteId:SharePoint 网站的 ID
  • listId:SharePoint list 的 ID
  • 字段: 字段值的键值对,例如 [{ Key: 'Title', Value: 'Software Engineer' }, { Key: 'Department', Value: 'Engineering' }]。 通常需要填写“标题”字段。

更新列表项

更新 SharePoint 列表中的现有项(行或记录)。 仅更新指定的字段;省略的字段保留其值。

所需参数:

  • siteId:SharePoint 网站的 ID
  • listId:SharePoint list 的 ID
  • itemId: 要更新的项目ID
  • 字段: 要更新的字段的键值对

可选参数:

  • etag: ETag 用于并发控制

删除列表项

从SharePoint list中删除项(行或记录)。

所需参数:

  • siteId:SharePoint 网站的 ID
  • listId:SharePoint list 的 ID
  • itemId: 要删除的项目ID

可选参数:

  • etag: ETag 用于并发控制

listColumns

获取 SharePoint 列表中的所有列。

所需参数:

  • siteId:SharePoint 网站的 ID
  • listId:SharePoint list 的 ID

创建列

在SharePoint list中创建新列。 支持许多列类型,包括文本、数字、选项、dateTime、布尔值、用户、查找、计算等。

所需参数:

  • siteId:SharePoint 网站的 ID
  • listId:SharePoint list 的 ID
  • 名称: 内部列名(程序标识符)
  • columnType: 列类型:文本、笔记、数字、整数、布尔值、dateTime、选择、多项选择、货币、查找、用户、URL、计算、术语、位置、地理位置、缩略图、计数器、计算值、contentTypeId、文件、附件、GUID、结果选择、审批状态

可选参数:

  • columnProperties: 类型特定设置(例如, { "maxLength": 255 } 文本, { "choices": ["A","B","C"] } 选择)
  • 描述: 列描述
  • displayName: 显示名称在UI中显示(默认为“name”)
  • 必填: 将列设为必填(默认:false)
  • 隐藏: 隐藏列(默认:false)

更新列

更新 SharePoint 列表中的现有列。

所需参数:

  • siteId:SharePoint 网站的 ID
  • listId:SharePoint list 的 ID
  • columnId: 要更新的列的ID

可选参数:

  • columnType: column类型(提供“columnProperties”时必填)
  • columnProperties: 用于更新的类型特定属性
  • 描述: 新描述
  • 显示名称: 新显示名称
  • 隐藏: 隐藏或显示列
  • 必填: 将列设为必填或可选

删除列

从 SharePoint 列表中删除一列。 警告: 此操作会移除所有项目中存储在该列中的所有数据。

所需参数:

  • siteId:SharePoint 网站的 ID
  • listId:SharePoint list 的 ID
  • columnId: 要删除的列的 ID

主要功能

站点管理

  • 按名称查找网站或浏览可访问的网站。
  • 通过精确的 URL 路径获取站点。
  • 列出子网站和子子网站。
  • 全面的网站层次结构导航。

文档库管理

  • 列出网站中的所有文档库。
  • 获取默认文档库。
  • 浏览文件夹内容(最多20个项目)。
  • 创建和管理文件夹结构。

文件操作

  • 创建文本和二进制文件(5MB或以下)。
  • 阅读文本和二进制文件(5MB或以下)。
  • 删除、重命名和移动文件和文件夹。
  • 跨文档库复制文件和文件夹。
  • 从SharePoint或OneDrive URL 上传文件。
  • 在所有可访问的网站上搜索文件和文件夹。
  • 获取文件和文件夹元数据。

异步操作

  • 跨文档库异步复制和移动文件和文件夹。
  • 使用操作令牌检查异步操作的状态。

列表操作

  • 创建、读取和删除列表。
  • 支持多个列表模板,包括泛型、文档库、事件和任务。
  • 使用基于角色的权限共享列表。
  • 通过创建、读取、更新和删除列表项来管理列表项。

列管理

  • 创建多种类型的列,例如文本、备注、数字、布尔值、日期和时间、选择、查阅、用户、URL、计算等。
  • 更新列属性和元数据。
  • 配置列要求和可见性。
  • 设置特定于类型的列属性。

共享和权限

  • 与用户共享文件、文件夹和列表。
  • 对读取、写入、参与和编辑角色使用基于角色的访问控制。
  • 发送电子邮件通知以便分享。
  • 请柬中的自定义消息。

安全性与合规性

  • 应用和删除敏感度标签。
  • 使用多个分配方法,包括标准、特权和自动分配方法。
  • 支持审核理由。
  • 将并发控制与 eTags 配合使用。

笔记

  • 文件操作仅限于上传和下载的 5 MB 或更少的文件。
  • 复制和移动操作是异步的。 使用 checkOperationStatus 来监控进度。
  • 复制和移动操作支持SharePoint中的跨库操作。
  • uploadFileFromUrl 需要有效的 SharePoint 或 OneDrive 源 URL。
  • eTag 为更新和删除提供并发控制。
  • 重复的文件夹名称自动添加数字后缀。
  • 无法撤消列表删除。
  • 删除列会删除该列中存储的所有数据。
  • findSite 当您省略 searchQuery时返回前 20 个相关网站。
  • getFolderChildren 返回指定父文件夹中排名前20的文件和文件夹。