SharePoint Reference (предварительный просмотр)

Замечание

Функции, описанные в этой статье, питаются стандартным жгутом, который использует опции выставления счетов, описанные в разделе «Лицензирование для агентов, работающих на стандартном жгуте». Узнайте, как получить доступ к стандартным функциям в стандартных агентах и потоках агентов доступа.

Important

Это предварительная версия функции.

• Microsoft выпускает предварительные версии функций перед официальным выпуском, чтобы клиенты могли досрочно получить доступ и предоставить отзывы.
• Предварительные версии функций имеют ограниченные функциональные возможности и не предназначены для использования в производственной среде.
• Microsoft может изменить названия и параметры инструментов MCP на стадии предварительной версии. Избегайте жестко закодированных зависимостей. Microsoft обеспечивает поддержку сценариев.
• Предварительные версии функции регулируются дополнительными условиями использования Microsoft.

Overview

Идентификатор сервера	URL-адрес на уровне клиента	Показать имя	Описание
mcp_SharePointRemoteServer	https://agent365.svc.cloud.microsoft/ agents/tenants/{tenantId}/servers/ mcp_SharePointRemoteServer	Sharepoint	Инструменты для операций с SharePoint. Этот сервер предназначен для управления сайтами, списками, элементами списка, столбцами, библиотеками документов, файлами, папками и предоставлением совместного доступа к файлам. Операции с файлами ограничены файлами размером не более 5 МБ.

Доступные средства

findSite

Находит сайты SharePoint, к которым у вас есть доступ. Возвращает сайты, соответствующие поисковому запросу, или 20 наиболее подходящих сайтов, если запрос не указан.

Необязательные параметры

• searchQuery: поисковый запрос (полное или частичное название сайта). Если параметр опущен, возвращаются первые 20 доступных сайтов.

getSiteByPath

Определяет сайт SharePoint по его точному имени хоста и относительному пути на сервере. Используйте этот метод только когда у вас есть полная структура URL сайта. Используйте findSite, если известно только название сайта.

Требуемые параметры:

• имя хоста: точное имя хоста (например, «contoso.sharepoint.com»)
• serverRelativePath: относительный путь на сервере (например, «sites/Marketing»). Начальная косая черта не является обязательной.

listSubsites

Перечисляет все подсайты (дочерние сайты) сайта SharePoint.

Требуемые параметры:

• siteId: идентификатор родительского сайта SharePoint (формат: «hostname,siteCollectionId,webId»)

ПеречислитьБиблиотекиДокументовНаСайте

Перечисляет библиотеки документов (диски) на указанном сайте SharePoint.

Необязательные параметры

• siteId: идентификатор сайта SharePoint (по умолчанию: «root»)

getDefaultDocumentLibraryInSite (получить библиотеку документов по умолчанию на сайте)

Получает библиотеку документов (диск) по умолчанию на сайте SharePoint.

Необязательные параметры

• siteId: идентификатор сайта SharePoint (по умолчанию: «root»)

getFolderChildren

Перечисляет первые 20 файлов и папок, содержащихся в указанном родительском элементе библиотеки документов (диск).

Требуемые параметры:

• documentLibraryId: идентификатор библиотеки документов (диск)

Необязательные параметры

• parentFolderId: ID родительской папки (по умолчанию: 'root').

найтиФайлИлиПапку

Находит файл или папку (DriveItem), доступные пользователю по поисковому запросу. Выполняет поиск по всем сайтам и библиотекам документов, к которым пользователь имеет доступ.

Требуемые параметры:

• searchQuery: поисковый запрос (полное или частичное имя файла)

getFileOrFolderMetadata

Получает метаданные файла или папки (DriveItem) из указанной библиотеки документов (диска) в SharePoint.

Требуемые параметры:

• fileOrFolderId: идентификатор файла или папки (DriveItem)
• documentLibraryId: идентификатор библиотеки документов (диск)

getFileOrFolderMetadataByUrl

Получает метаданные для файла или папки (DriveItem) с URL для совместного использования. Метаданные могут получить только пользователи с существующими явными правами доступа к файлу.

Требуемые параметры:

• fileOrFolderUrl: URL-адрес файла или папки. URL-адрес не используется для предоставления доступа пользователю; у него уже должен быть явный доступ.

readSmallTextFile

Читает (загружает) текстовый файл меньше 5 МБ из определённой библиотеки документов (диска).

Требуемые параметры:

• fileId: идентификатор файла (DriveItem) для чтения или скачивания
• documentLibraryId: идентификатор библиотеки документов (диск)

readSmallBinaryFile

Считывает двоичный файл размером менее 5 МБ из определенной библиотеки документов (диска). Содержимое файла возвращается в виде строки в формате Base64.

Требуемые параметры:

• fileId: идентификатор файла (DriveItem) для чтения или скачивания
• documentLibraryId: идентификатор библиотеки документов (диск)

создатьМаленькийТекстовыйФайл

Создаёт или загружает текстовый файл площадью менее 5 МБ на определённую библиотеку документов (диск).

Требуемые параметры:

• Имя файла: Название файла с расширением.
• содержаниеТекст: Текстовое содержание файла.
• documentLibraryId: идентификатор библиотеки документов (диск)

Необязательные параметры

• parentFolderId: ID родительской папки (по умолчанию: 'root').

createSmallBinaryFile

Создает бинарный файл размером менее 5 МБ, кодируя его содержимое в Base64 и помещая в указанную библиотеку документов (диск).

Требуемые параметры:

• Имя файла: Название файла с расширением.
• base64Content: содержимое бинарного файла, закодированное как строка Base64.
• documentLibraryId: идентификатор библиотеки документов (диск)

Необязательные параметры

• parentFolderId: ID родительской папки (по умолчанию: 'root').

создатьПапку

Создает новую папку (DriveItem) в указанной библиотеке документов (диске). Если папка с таким именем уже существует, система добавляет к имени числовой суффикс (например, NewFolder (1)).

Требуемые параметры:

• folderName: название папки
• documentLibraryId: идентификатор библиотеки документов (диск)

Необязательные параметры

• parentFolderId: ID родительской папки (по умолчанию: 'root').

переименоватьФайлИлиПапку

Переименовывает файл или папку (DriveItem) в указанной библиотеке документов (диске). Новое имя должно соответствовать соглашениям об именовании.

Требуемые параметры:

• documentLibraryId: идентификатор библиотеки документов (диск)
• fileOrFolderId: идентификатор файла или папки для переименования
• newFileOrFolderName: новое имя

Необязательные параметры

• etag: ETag для контроля одновременного доступа

удалитьФайлИлиПапку

Удаляет файл или папку (DriveItem) из указанной библиотеки документов (диска).

Требуемые параметры:

• documentLibraryId: идентификатор библиотеки документов (диск)
• fileOrFolderId: идентификатор файла или папки для удаления

Необязательные параметры

• etag: ETag для контроля одновременного доступа

moveFileOrFolder

Перемещает файл или папку (DriveItem) в папку назначения. Поддерживает перемещение между различными библиотеками документов (дисками) внутри SharePoint. Эта операция асинхронна. Используйте checkOperationStatus для мониторинга прогресса.

Требуемые параметры:

• sourcedoclibid: идентификатор исходной библиотеки документов (диска)
• sourcefileid: идентификатор исходного файла или папки для перемещения
• destdoclibid: идентификатор библиотеки документов назначения (диск)
• destfolderid: идентификатор папки назначения (должна присутствовать)

Необязательные параметры

• newfilename: новое имя для перемещенного элемента

copyFileOrFolder

Копирует файл или папку (DriveItem) в папку назначения. Поддерживает копирование между различными библиотеками документов в SharePoint. Эта операция асинхронна. Используйте checkOperationStatus для мониторинга прогресса.

Требуемые параметры:

• sourcedoclibid: идентификатор исходной библиотеки документов (диска)
• sourcefileid: идентификатор исходного файла или папки для копирования
• destdoclibid: идентификатор библиотеки документов назначения (диск)
• destfolderid: идентификатор папки назначения (должна присутствовать)

Необязательные параметры

• newfilename: новое имя для скопированного элемента

checkOperationStatus

Проверяет статус асинхронной операции, например копирования или перемещения, используя токен операции, полученный из исходной операции.

Требуемые параметры:

• operationToken: токен операции, выданный асинхронной операцией, например copyFileOrFolder или moveFileOrFolder

uploadFileFromUrl

Загружает файл по URL-адресу SharePoint или OneDrive в папку назначения в библиотеке документов (диск). Файл копируется из исходного URL-адреса, поэтому исходный файл не изменяется.

Требуемые параметры:

• sourceUrl: URL-адрес источника (должен быть корректным URL-адресом SharePoint или OneDrive)
• destinationDocumentLibraryId: идентификатор библиотеки документов назначения. Используйте me для OneDrive пользователя

Необязательные параметры

• destinationFolderId: идентификатор папки назначения (по умолчанию: root)
• имя файла: новое имя файла; по умолчанию используется оригинальное имя файла

передатьФайлИлиПапку

Отправляет приглашение для совместного доступа, предоставляющее разрешения на чтение или запись файла или папки (DriveItem) в указанной библиотеке документов (диске).

Требуемые параметры:

• documentLibraryId: идентификатор библиотеки документов (диск)
• fileOrFolderId: идентификатор файла или папки для совместного использования
• recipientEmails: массив адресов электронной почты получателей
• roles: массив ролей: «чтение», «запись» (роль «запись» предоставляет права как на чтение, так и на запись)

Необязательные параметры

• сообщение: настраиваемое сообщение для письма-приглашения (по умолчанию: «Вот файл, над которым мы работаем вместе.»)
• sendInvitation: отправить ли приглашение на совместное использование (по умолчанию: true)

установитьМеткуКонфиденциальностиНаФайл

Присваивает метку чувствительности файлу, находящемуся в указанной библиотеке документов (диске).

Требуемые параметры:

• documentLibraryId: идентификатор библиотеки документов (диск)
• fileId: идентификатор файла (DriveItem)
• sensitivityLabelId: идентификатор метки чувствительности; — пустая строка для ее удаления

Необязательные параметры

• assignmentMethod: метод назначения: «standard», «привилегированный», «auto» или «unknownFutureValue» (по умолчанию: «привилегированный»)
• justificationText: текст обоснования для целей аудита; требуется при понижении или удалении метки (по умолчанию: «Changed by MCPServer»)

listLists

Извлекает все списки SharePoint, доступные на конкретном SharePoint сайте. Используйте для определения, какие списки существуют на сайте.

Требуемые параметры:

• siteId: идентификатор сайта SharePoint (формат: «hostname,siteCollectionId,webId»)

createList

Создает новый список SharePoint на сайте.

Требуемые параметры:

• siteId: идентификатор сайта SharePoint
• displayName: отображаемое имя нового списка

Необязательные параметры

• columns: коллекция столбцов в виде пар ключ-значение: [{ Key: 'JobTitle', Value: 'text' }]. Допустимые типы: текстовое сообщение, multilineText, число, логический, dateTime, выбор, поиск, personOrGroup, гиперссылка, валюта, сумма
• template: тип шаблона списка (по умолчанию: «genericList»). Варианты: genericList, documentLibrary, события, задачи, объявления, контакты, ссылки, опрос, issueTracking, discussionBoard

deleteList

Удаляет список SharePoint с сайта. Удаляет весь контейнер списка вместе со всеми его элементами. Это действие не может быть отменено.

Требуемые параметры:

• siteId: идентификатор сайта SharePoint
• listId: идентификатор списка для удаления

Необязательные параметры

• etag: ETag для контроля одновременного доступа

sendInviteForList

Отправляет приглашение для предоставления доступа к списку SharePoint.

Требуемые параметры:

• listId: идентификатор списка SharePoint для предоставления доступа
• recipientEmails: массив адресов электронной почты получателей
• role: роль: «read» (только просмотр), «contribute» (просмотр, добавление, обновление, удаление элементов), «edit» (полное редактирование, включая структуру списка)

Необязательные параметры

• siteUrl: URL-адрес сайта SharePoint, содержащего этот список
• sendEmail: стоит ли отправлять уведомление по электронной почте (по умолчанию: true)

listListItems

Получает элементы (строки/записи) из определенного списка SharePoint.

Требуемые параметры:

• siteId: идентификатор сайта SharePoint
• listId: идентификатор списка SharePoint

getListItem

Получает один элемент (строку или запись) из список SharePoint по его идентификатору.

Требуемые параметры:

• siteId: идентификатор сайта SharePoint
• listId: идентификатор списка SharePoint
• itemId: идентификатор конкретного элемента списка

createListItem

Создает новый элемент (строку или запись) в списке SharePoint.

Требуемые параметры:

• siteId: идентификатор сайта SharePoint
• listId: идентификатор списка SharePoint
• Области: Пары ключ-значение для значений полей, таких [{ Key: 'Title', Value: 'Software Engineer' }, { Key: 'Department', Value: 'Engineering' }]как . Поле «Title» обычно обязательно.

updateListItem

Обновляет существующий элемент (строку или запись) в списке SharePoint. Обновляются только указанные поля; опущенные поля сохраняют свои значения.

Требуемые параметры:

• siteId: идентификатор сайта SharePoint
• listId: идентификатор списка SharePoint
• itemId: идентификатор элемента для обновления
• fields: пары ключ-значение для обновления

Необязательные параметры

• etag: ETag для контроля одновременного доступа

deleteListItem

Удаляет элемент (строку или запись) из списка SharePoint.

Требуемые параметры:

• siteId: идентификатор сайта SharePoint
• listId: идентификатор списка SharePoint
• itemId: идентификатор элемента для удаления

Необязательные параметры

• etag: ETag для контроля одновременного доступа

списокСтолбцов

Получает все столбцы из списка SharePoint.

Требуемые параметры:

• siteId: идентификатор сайта SharePoint
• listId: идентификатор списка SharePoint

createColumn

Создает новый столбец в списке SharePoint. Поддерживаются многие типы столбцов, включая текст, число, выбор, дата и время, логический, пользователь, поиск, вычисляемый и другие.

Требуемые параметры:

• siteId: идентификатор сайта SharePoint
• listId: идентификатор списка SharePoint
• name: внутреннее имя столбца (программный идентификатор)
• columnType: тип столбца: текст, примечание, число, целое число, логический, дата и время, выбор, множественный выбор, валюта, поиск, пользователь, URL-адрес, вычисляемый, термин, мультитермин, местоположение, геолокация, миниатюра, счетчик, вычисленный, идентификатор типа содержимого, файл, вложение, GUID, вариант результата, статус утверждения

Необязательные параметры

• columnProperties: параметры для конкретного типа (например, { "maxLength": 255 } для текста, { "choices": ["A","B","C"] } для выбора)
• description: описание столбца
• displayName: отображаемое имя, отображаемое в пользовательском интерфейсе (по умолчанию — «name»).
• required: сделать столбец обязательным (по умолчанию: false)
• hidden: скрыть столбец из представлений (по умолчанию: false)

updateColumn

Обновляет существующий столбец в списке SharePoint.

Требуемые параметры:

• siteId: идентификатор сайта SharePoint
• listId: идентификатор списка SharePoint
• columnId: идентификатор столбца для обновления

Необязательные параметры

• columnType: тип столбца (требуется при использовании «columnProperties»)
• columnProperties: свойства определенного типа для обновления
• description: новое описание
• displayName: новое отображаемое имя
• hidden: скрыть или показать столбец
• required: сделать столбец обязательным или необязательным

deleteColumn

Удаляет столбец из списка SharePoint. Warning (предупреждение): это действие удаляет все данные, хранящиеся в этом столбце для всех элементов.

Требуемые параметры:

• siteId: идентификатор сайта SharePoint
• listId: идентификатор списка SharePoint
• columnId: идентификатор столбца, который нужно удалить

Ключевые особенности

Управление сайтами

• Найдите сайты по названию или просмотреть доступные сайты.
• Получить сайт по точному URL-адресу.
• Перечислить дочерние сайты и подсайты.
• Полная навигация по иерархии сайта.

Управление библиотеками документов

• Перечислить все библиотеки документов на сайте.
• Получить библиотеку документов по умолчанию.
• Просмотр содержимого папок (до 20 элементов).
• Создавать и управлять структурой папок.

Операции с файлами

• Создайте текстовые и двоичные файлы (5 МБ или меньше).
• Читайте текстовые и бинарные файлы (5 МБ или меньше).
• Удалять, переименовывать и перемещать файлы и папки.
• Копировать файлы и папки между библиотеками документов.
• Отправка файлов, используя URL-адреса из SharePoint или OneDrive.
• Поиск файлов и папок по всем доступным сайтам.
• Получить метаданные файлов и папок.

Асинхронные операции

• Копировать и перемещать файлы и папки асинхронно между библиотеками документов.
• Проверить статус асинхронных операций, используя токены операций.

Операции со списком

• Создавайте, читайте и удаляйте списки.
• Поддержка различных шаблонов списков, включая универсальный, библиотеку документов, события и задачи.
• Делитесь списками с разрешениями, основанными на ролях.
• Управляйте элементами списка, создавая, читая, обновляя и удаляя их.

Управление столбцами

• Создавайте столбцы с широким спектром типов, например: текст, заметка, число, логический, dateTime (дата и время), выбор, поиск, пользователь, URL-адрес, вычисляемый и другие.
• Обновляйте свойства и метаданные столбцов.
• Настройте требования к столбцам и их видимость.
• Установите свойства столбцов, характерные для конкретного типа.

Общий доступ и разрешения

• Делитесь файлами, папками и списками с пользователями.
• Используйте контроль доступа на основе ролей с ролями чтения, записи, внесения и редактирования.
• Уведомления по электронной почте для обмена.
• Индивидуальные сообщения в приглашениях.

Безопасность и соответствие требованиям

• Применение и удаление меток конфиденциальности.
• Используйте несколько методов назначения, включая стандартный, привилегированный и автоматический.
• Поддержка обоснования для аудита.
• Используется управление параллелизмом с помощью eTags.

Примечания

• Операции с файлами ограничены файлами размером 5 МБ или меньше для загрузки и скачивания.
• Операции копирования и перемещения проводятся асинхронно. Используйте checkOperationStatus для мониторинга прогресса.
• Операции копирования и перемещения поддерживают операции между библиотеками внутри SharePoint.
• uploadFileFromUrl требует действительный URL-адрес источника SharePoint или OneDrive.
• Теги eTag обеспечивают контроль параллелизма при обновлениях и удалениях.
• Автоматический числовой суффикс для дублирующихся имен папок.
• Удаление списка нельзя отменить.
• Удаление столбца удаляет все данные, хранящиеся в этом столбце.
• Поисковые операции по умолчанию возвращают 20 первых результатов.