Dokumentacja programu Microsoft SharePoint i programu OneDrive MCP Server

Omówienie

Dostępne narzędzia

createFolder

Tworzy nowy folder w określonej bibliotece dokumentów jako element podrzędny określonego folderu nadrzędnego. Jeśli nie określisz biblioteki dokumentów, serwer używa usługi OneDrive użytkownika. Jeśli nie określisz folderu nadrzędnego, serwer utworzy folder w katalogu głównym. Jeśli folder już istnieje o tej samej nazwie, serwer tworzy nowy folder z sufiksem liczbowym, takim jak NewFolder (1).

Parametry wymagane

• folderName(ciąg) — nazwa folderu do utworzenia. Jeśli folder o tej samej nazwie już istnieje, serwer dodaje sufiks liczbowy do nowej nazwy folderu, na przykład NewFolder (1).
• documentLibraryId(ciąg) — identyfikator biblioteki dokumentów (nazywanej również dyskiem), w której chcesz utworzyć folder. Jeśli chcesz utworzyć folder na dysku użytkownika lub w usłudze OneDrive, na przykład "mój dysk" lub "mój dysk", wyślij "me" jako documentLibraryId.

Parametry opcjonalne

• parentFolderId(ciąg, default = "root") — identyfikator folderu nadrzędnego, w którym zostanie utworzony nowy folder. Jeśli nie zostanie określony, domyślny katalog główny biblioteki dokumentów.

findSite

Znajduje witryny programu SharePoint, do których użytkownik może uzyskać dostęp. To narzędzie może znaleźć określoną witrynę na podstawie podanego zapytania wyszukiwania lub znaleźć 20 najważniejszych odpowiednich witryn dostępnych dla użytkownika, jeśli nie podasz zapytania wyszukiwania.

Parametry wymagane

None

Parametry opcjonalne

• searchQuery(ciąg, default = null) — zapytanie wyszukiwania, które może być nazwą całej lub częściowej witryny. Udostępnienie zapytania wyszukiwania pomaga efektywnie wyszukiwać witrynę, ale tylko wtedy, gdy użytkownik szuka określonej witryny. Jeśli na przykład użytkownik poprosi o witrynę o nazwie xyz, zostanie przekazana xyzsearchQueryjako . Jeśli użytkownik po prostu poprosi o "moje witryny", pozostaw ten parametr pusty.

listDocumentLibrariesInSite

Wyświetla listę bibliotek dokumentów (nazywanych również dyskami) w określonej witrynie programu SharePoint. Jeśli nie określisz lokacji, serwer używa lokacji głównej.

Parametry wymagane

None

Parametry opcjonalne

• siteId: identyfikator witryny (ustawienie domyślne: root)

findFileOrFolder

Znajduje plik lub folder (nazywany również DriveItem), do którego użytkownik może uzyskać dostęp, przekazując zapytanie wyszukiwania.

Parametry wymagane

• searchQuery: kwerenda wyszukiwania, która może być cała lub częściowa nazwa pliku

renameFileOrFolder

Zmień nazwę pliku lub folderu (określanego również jako DriveItems) w określonej bibliotece dokumentów. Uwaga: nowa nazwa musi być zgodna z konwencjami nazewnictwa.

Parametry wymagane

• documentLibraryId: identyfikator biblioteki dokumentów (ciąg)
• fileOrFolderId: identyfikator pliku lub folderu (ciąg)
• newFileOrFolderName: nowa nazwa pliku lub folderu (ciąg)

deleteFileOrFolder

Usuń plik lub folder z określonej biblioteki dokumentów.

Parametry wymagane

• documentLibraryId: identyfikator biblioteki dokumentów (ciąg)
• fileOrFolderId: identyfikator pliku lub folderu (ciąg)

readSmallTextFile

Odczytywanie (pobieranie) pliku tekstowego z określonej biblioteki dokumentów. Jeśli nie określisz biblioteki dokumentów, zostanie użyta usługa OneDrive użytkownika. Musisz podać identyfikator fileId (driveItemId pliku), aby zidentyfikować i pobrać plik.

Parametry wymagane

• fileId(ciąg)
• documentLibraryId(ciąg) — identyfikator biblioteki dokumentów (nazywanej również dyskiem) pliku, który chcesz odczytać. Jeśli użytkownik poprosi Cię o odczytanie lub pobranie pliku na dysku lub w usłudze Onedrive, na przykład — odczyt pliku w folderze "mój dysk", odczyt pliku w polu "my onedrive" należy wysłać w polu "me" jako documentLibraryId.

moveSmallFile

Przenieś plik znajdujący się w określonej bibliotece dokumentów do innego folderu. To narzędzie obsługuje tylko przenoszenie plików mniejszych niż 5 MB i przenoszenie, które znajdują się w tej samej lokacji. Nie można przenosić plików między dyskami przy użyciu tego żądania.

Parametry wymagane

• documentLibraryId(ciąg) — identyfikator biblioteki dokumentów (nazywanej również dyskiem) pliku, który chcesz przenieść. Jeśli użytkownik poprosi Cię o przeniesienie pliku na dysku lub w usłudze OneDrive, na przykład — przenieś plik w "mój dysk", przenieś plik w polu "my onedrive", który powinien zostać wysłany w polu "me" jako documentLibraryId.
• fileId(ciąg) — identyfikator pliku do przeniesienia
• newParentFolderId(string) — identyfikator folderu docelowego do przeniesienia pliku do. Powinna znajdować się w tej samej bibliotece dokumentów co oryginalna lokalizacja pliku.

getFileOrFolderMetadata

Pobieranie metadanych pliku lub folderu z określonej biblioteki dokumentów w witrynie programu SharePoint.

Parametry wymagane

• FileOrFolderId(ciąg) — identyfikator pliku lub folderu. Są one również nazywane DriveItems. Ich identyfikator może być również czasami określany jako driveItemId.
• documentLibraryId(ciąg) — identyfikator biblioteki dokumentów (nazywanej również dyskiem) pliku lub folderu, którego metadane są potrzebne. Jeśli użytkownik prosi o pobranie pliku lub folderu na dysku lub w usłudze Onedrive, na przykład — "Pobierz metadane pliku na dysku" lub "Pobierz metadane folderu w usłudze onedrive", należy wysłać w folderze "me" jako documentLibraryId.

createSmallTextFile

Utwórz lub przekaż plik tekstowy mniejszy niż 5 MB do określonej biblioteki dokumentów. Jeśli nie określisz biblioteki dokumentów, zostanie użyta usługa OneDrive użytkownika. Plik można przekazać do określonego folderu. Jeśli nie określisz folderu, plik zostanie przekazany do folderu głównego.

Parametry wymagane

• nazwa pliku (ciąg) — nazwa pliku do utworzenia
• contentText (ciąg) — zawartość tekstowa pliku do utworzenia
• documentLibraryId (ciąg) — identyfikator biblioteki dokumentów (nazywanej również dyskiem) dla pliku. Jeśli użytkownik poprosi o utworzenie pliku na dysku lub w usłudze OneDrive, na przykład "utwórz plik na dysku" lub "utwórz plik w mojej usłudze onedrive", wyślij "me" jako documentLibraryId.

Parametry opcjonalne

• parentfolderId(ciąg, default = "root") — identyfikator folderu na dysku, aby dodać nowy plik.

getFileOrFolderMetadataByUrl

Pobieranie metadanych dla pliku lub folderu z adresu URL udostępniania. Metadane mogą uzyskać tylko użytkownicy z jawnymi uprawnieniami dostępu do pliku.

Parametry wymagane

• fileOrFolderUrl:(ciąg) — adres URL pliku lub folderu (określany również jako DriveItems). Adres URL nie jest zrealizowany, aby udostępnić go użytkownikowi; muszą już mieć jawny dostęp do pliku.

shareFileOrFolder

Wyślij zaproszenie do udostępniania, aby udzielić uprawnień do pliku lub folderu w określonej bibliotece dokumentów. Obsługuje przypisywanie ról i powiadamianie adresatów.

Parametry wymagane

• documentLibraryId: identyfikator biblioteki dokumentów (ciąg, wymagany)
• fileOrFolderId: identyfikator pliku lub folderu (ciąg, wymagany)
• recipientEmails:(string[], Required) — adresy e-mail adresatów do zaproszenia. Wymagana jest co najmniej jedna wiadomość e-mail adresata.

Parametry opcjonalne

• roles(string[]) — role do przypisania do adresatów. Zaakceptowane wartości: odczyt, zapis (zapis przyznaje zarówno dostęp do odczytu, jak i zapisu). Wartość domyślna do odczytu roli, jeśli nie zostanie określona.
• sendInvitation(bool, default = true) — wskazuje, czy wysłać zaproszenie do udostępniania. Wartość domyślna to true, jeśli nie zostanie określona.
• message(string, default = "Oto plik, nad który współpracujemy).") — wiadomość niestandardowa do uwzględnienia w wiadomości e-mail z zaproszeniem. Domyślnie jest wyświetlany standardowy komunikat, jeśli nie zostanie określony.

getFolderChildren

Wylicza 20 pierwszych plików i folderów w określonym folderze nadrzędnym w bibliotece dokumentów. Jeśli nie określisz biblioteki dokumentów, zostanie użyta usługa OneDrive użytkownika.

Parametry wymagane

• documentLibraryId(ciąg) — identyfikator biblioteki dokumentów (nazywanej również dyskiem) folderu nadrzędnego. Jeśli użytkownik prosi o pobranie plików w folderze na dysku lub w usłudze OneDrive, takich jak "pobieranie plików w folderze na dysku" lub "pobieranie plików w folderze w usłudze onedrive", wyślij "me" jako documentLibraryId.

Parametry opcjonalne

• parentFolderId:(string, default = "root") — identyfikator folderu nadrzędnego (DriveItem), którego pliki i foldery znajdują się na liście. Wartość domyślna folderu głównego biblioteki dokumentów, jeśli nie zostanie określona.

Echo

Wysyła wiadomość z powrotem do klienta.

Parametry wymagane

• komunikat: Komunikat do wysłania z powrotem

setSensitivityLabelOnFile

Ustaw etykietę poufności pliku z określonej biblioteki dokumentów.

Parametry wymagane

• documentLibraryId(ciąg) — identyfikator biblioteki dokumentów, znany również jako driveId, biblioteki dokumentów
• fileId(string) — identyfikator pliku, znany również jako driveItemId, pliku
• sensitivityLabelId(ciąg) — wymagane. Identyfikator etykiety poufności do przypisania lub pusty ciąg w celu usunięcia etykiety poufności.

Parametry opcjonalne

• assignmentMethod(string, default = "privileged") — metoda przypisania etykiety w dokumencie. Wskazuje, czy przypisanie etykiety zostało wykonane automatycznie, standardowe lub jako operacja uprzywilejowana (odpowiednik operacji administratora). Możliwe wartości to standardowe, uprzywilejowane, automatyczne i nieznaneFutureValue.
• justificationText(string, default = "Changed by MCPServer") — opcjonalne. Tekst uzasadnienia do celów inspekcji i jest wymagany podczas obniżania lub usuwania etykiety.

getDefaultDocumentLibraryInSite

Pobierz domyślną bibliotekę dokumentów (nazywaną również dyskiem) w witrynie programu SharePoint. Jeśli nie określisz witryny, zostanie użyta witryna główna.

Parametry wymagane

None

Parametry opcjonalne

• siteId: identyfikator witryny (ustawienie domyślne: root)

Kluczowe cechy i funkcje

Zarządzanie folderami

• Tworzenie folderów z automatycznym rozpoznawaniem konfliktów nazewnictwa
• Wyliczanie elementów podrzędnych folderów (pierwszych 20)
• Przenoszenie plików między folderami (w tej samej witrynie)

Operacje na plikach

• Tworzenie i przekazywanie małych plików tekstowych (< 5 MB)
• Odczytywanie i pobieranie plików tekstowych
• Tworzenie kopii zapasowych plików i folderów
• Tworzenie kopii zapasowych plików i folderów
• Pobieranie metadanych plików i folderów według identyfikatora lub adresu URL

Odnajdywanie witryn i bibliotek

• Znajdowanie witryn programu SharePoint według zapytania wyszukiwania
• Wyświetlanie listy bibliotek dokumentów w witrynie
• Pobieranie domyślnej biblioteki dokumentów

Udostępnianie i uprawnienia

• Udostępnianie plików i folderów przy użyciu przypisań ról
• Wysyłanie zaproszeń do udostępniania za pomocą wiadomości niestandardowych
• Kontrola dostępu za pośrednictwem jawnych uprawnień

Zabezpieczenia i zgodność

• Ustawianie etykiet poufności dla plików
• Obsługa metod przypisywania uprzywilejowanego, standardowego i automatycznego
• Tekst uzasadnienia inspekcji zgodności

Integracja

• Obsługa usług OneDrive i SharePoint Online
• Połączenie serwera specyficznego dla dzierżawy
• Abstrakcja driveItem dla plików i folderów

Uwagi

1. Domyślna biblioteka dokumentów to "me" (użytkownik OneDrive)
2. Domyślny folder nadrzędny to "root"
3. Konflikty nazw folderów rozwiązane z sufiksami liczbowymi
4. Plik jest ograniczony do mniej niż 5 MB i w tej samej lokacji
5. Adresy URL udostępniania wymagają jawnych uprawnień dostępu
6. Element driveItems reprezentuje zarówno pliki, jak i foldery
7. 20 pierwszych limitów w wyliczaniu elementów podrzędnych folderów