Referência ao Microsoft SharePoint e OneDrive MCP Server

Descrição geral

Ferramentas disponíveis

createFolder

Cria uma nova pasta dentro de uma Biblioteca de Documentos especificada como filho da pasta pai especificada. Se não especificares uma Biblioteca de Documentos, o servidor usa o OneDrive do utilizador. Se não especificares uma pasta pai, o servidor cria a pasta na raiz. Se já existir uma pasta com o mesmo nome, o servidor cria a nova pasta com um sufixo numérico, como NewFolder (1).

Parâmetros necessários

• folderName(string) – Nome da pasta a criar. Se já existir uma pasta com o mesmo nome, o servidor adiciona um sufixo numérico ao novo nome da pasta, como NewFolder (1).
• documentLibraryId(string) – ID da Biblioteca de Documentos (também chamada de Drive) onde pretende criar a pasta. Se quiseres criar uma pasta no disco do utilizador ou no OneDrive dele, como "my drive" ou "my onedrive", envia "me" como o documentLibraryId.

Parâmetros opcionais

• parentFolderId(string, default = "root") – ID da pasta principal sob a qual a nova pasta será criada. Por defeito fica na raiz da biblioteca de documentos se não for especificado.

findSite

Encontra sites SharePoint aos quais o utilizador pode aceder. Esta ferramenta pode encontrar um site específico com base numa consulta de pesquisa que fornece, ou encontrar os 20 sites mais relevantes acessíveis pelo utilizador caso não forneça uma consulta de pesquisa.

Parâmetros necessários

None

Parâmetros opcionais

• searchQuery(string, default = null) – Consulta de pesquisa que pode ser o nome total ou parcial do site. Fornecer uma consulta de pesquisa ajuda a pesquisar eficientemente um site, mas apenas se o utilizador estiver à procura de um site específico. Por exemplo, se o utilizador pedir um site chamado xyz, passaria xyz por .searchQuery Se o utilizador apenas pedir "os meus sites", deixa esse parâmetro vazio.

listaDocumentBibliotecasInSite

Lista Bibliotecas de Documentos (também chamadas de Drives) no site SharePoint especificado. Se não especificares um site, o servidor usa o site raiz.

Parâmetros necessários

None

Parâmetros opcionais

• SiteId: ID do site (por defeito: root)

FindFileOrFolder

Encontra um ficheiro ou uma pasta (também chamada de DriveItem) à qual o utilizador pode aceder através de uma consulta de pesquisa.

Parâmetros necessários

• searchQuery: Consulta de pesquisa que pode ser o nome total ou parcial do ficheiro

renameFileOrFolder

Renomeie um ficheiro ou uma pasta (também referida como DriveItems) dentro da Biblioteca de Documentos especificada. Nota: O novo nome deve cumprir as convenções de nomenclatura.

Parâmetros necessários

• documentLibraryId: ID da Biblioteca de Documentos (string)
• fileOrFolderId: ID de ficheiro ou pasta (string)
• newFileOrFolderName: Novo nome para o ficheiro ou pasta (string)

deleteFileOrFolder

Apague um ficheiro ou uma pasta da Biblioteca de Documentos especificada.

Parâmetros necessários

• documentLibraryId: ID da Biblioteca de Documentos (string)
• fileOrFolderId: ID de ficheiro ou pasta (string)

readSmallTextFile

Leia (descarregue) um ficheiro de texto de uma Biblioteca de Documentos específica. Se não especificares uma Biblioteca de Documentos, o OneDrive do utilizador é usado. Precisa de fornecer um fileId (driveItemId de um ficheiro) para identificar e descarregar o ficheiro.

Parâmetros necessários

• fileId(string)
• documentLibraryId(string) – Id da Biblioteca de Documentos (também chamada de Drive) do ficheiro que pretende ler. Se o utilizador lhe pedir para ler ou descarregar um ficheiro no disco dele ou no Onedrive, por exemplo - Lê um ficheiro em "my drive", lê um ficheiro em "my onedrive" deves enviar "me" como documentLibraryId.

moveSmallFile

Move um ficheiro localizado na Biblioteca de Documentos especificada para outra pasta. Esta ferramenta só suporta mover ficheiros com menos de 5 MB e movimentos que estejam dentro do mesmo site. Não podes mover ficheiros entre discos usando este pedido.

Parâmetros necessários

• documentLibraryId(string) – Id da Biblioteca de Documentos (também chamada de Drive) do ficheiro que pretende mover. Se um utilizador lhe pedir para mover um ficheiro no disco dele ou no Onedrive, por exemplo - Mover um ficheiro em "my drive", mover um ficheiro em "my onedrive" deve enviar "me" como documentLibraryId.
• fileId(string) – Id do ficheiro a mover
• newParentFolderId(string) – O ID da pasta de destino para onde se deve mover o ficheiro. Deve estar na mesma biblioteca de documentos da localização original do ficheiro.

getFileOrFolderMetadata

Obtenha metadados de um ficheiro ou de uma pasta da Biblioteca de Documentos especificada num site SharePoint.

Parâmetros necessários

• FileOrFolderId(string) – Id de um ficheiro ou pasta. Também são chamados DriveItems. E o seu Id também pode ser por vezes referido como driveItemId.
• documentLibraryId(string) – Id da Biblioteca de Documentos (também chamada de Drive) do ficheiro ou pasta cujos metadados precisas dele. Se o utilizador lhe pedir para obter um ficheiro ou pasta no seu disco ou no Onedrive, por exemplo - "Obter metadados de um ficheiro no meu disco" ou "Obter metadados de uma pasta no meu Onedrive", deve enviar "me" como documentLibraryId.

createSmallTextFile

Crie ou carregue um ficheiro de texto com menos de 5 MB para uma Biblioteca de Documentos específica. Se não especificares uma Biblioteca de Documentos, o OneDrive do utilizador é usado. Podes carregar o ficheiro numa pasta específica. Se não especificares uma pasta, o ficheiro é carregado para a pasta raiz.

Parâmetros necessários

• Nome do ficheiro (string) – Nome do ficheiro a criar
• contentText (string) – Conteúdo de texto do ficheiro a criar
• documentLibraryId (string) – ID da Biblioteca de Documentos (também chamada de Drive) para o ficheiro. Se um utilizador lhe pedir para criar um ficheiro no seu disco ou no OneDrive deles, como "criar um ficheiro no meu disco" ou "criar um ficheiro no meu OneDrive", envie "me" como documentLibraryId.

Parâmetros opcionais

• parentfolderId(string, default = "root") – ID de pasta dentro do disco para adicionar o novo ficheiro.

getFileOrFolderMetadataByUrl

Obtenha metadados de um ficheiro ou pasta a partir de uma URL de partilha. Apenas utilizadores com permissões explícitas para aceder ao ficheiro podem obter os metadados.

Parâmetros necessários

• fileOrFolderUrl:(string) – URL do ficheiro ou pasta (também referido como DriveItems). A URL não é resgatada para a partilhar com o utilizador; Devem já ter acesso explícito ao ficheiro.

shareFileOrFolder

Envie um convite de partilha para conceder permissões a um ficheiro ou pasta dentro de uma Biblioteca de Documentos especificada. Suporta a atribuição de funções e a notificação dos destinatários.

Parâmetros necessários

• documentLibraryId: ID da Biblioteca de Documentos (string, Obrigatório)
• fileOrFolderId: ID de ficheiro ou pasta (string, Obrigatório)
• recipientesEmails:(string[], Obrigatório) – Endereços de email dos destinatários a convidar. É necessário pelo menos um email do destinatário.

Parâmetros opcionais

• roles(string[]) – Papéis a atribuir aos destinatários. Valores aceites: ler, escrever (escrever concessões tanto para leitura como para escrita de acesso). Por defeito, o papel de leitura é especificado se não for especificado.
• sendInvitation(bool, default = true) – Indica se deve enviar um convite de partilha. Por defeito, é verdadeiro se não for especificado.
• message(string, default = "Aqui está o ficheiro em que estamos a colaborar.") – Mensagem personalizada para incluir no email de convite. Por defeito é uma mensagem padrão se não for especificada.

getFolderChildren

Enumera os 20 principais ficheiros e pastas dentro de uma pasta pai especificada numa Biblioteca de Documentos. Se não especificares uma Biblioteca de Documentos, o OneDrive do utilizador é usado.

Parâmetros necessários

• documentLibraryId(string) – ID da Biblioteca de Documentos (também chamada de Drive) para a pasta pai. Se um utilizador lhe pedir para obter ficheiros numa pasta no seu disco ou no OneDrive, como "obter ficheiros numa pasta no meu disco" ou "obter ficheiros numa pasta no meu OneDrive", envie "me" como documentLibraryId.

Parâmetros opcionais

• parentFolderId:(string, default = "root") – ID da pasta principal (DriveItem) cujos ficheiros e pastas estão listados. Por defeito fica na pasta raiz da Biblioteca de Documentos se não for especificado.

Echo

Envia a mensagem de volta ao cliente.

Parâmetros necessários

• mensagem: Mensagem a enviar de volta

setSensibilidadeEtiquetaOnFile

Defina o rótulo de sensibilidade de um ficheiro a partir da Biblioteca de Documentos especificada.

Parâmetros necessários

• documentLibraryId(string) – O ID da biblioteca de documentos, também conhecido como driveId, da biblioteca de documentos
• fileId(string) – O ID do ficheiro, também conhecido como driveItemId, do ficheiro
• sensitivityLabelId(string) – Obrigatório. ID do rótulo de sensibilidade a atribuir, ou string vazio para remover o rótulo de sensibilidade.

Parâmetros opcionais

• Metodoassignment(string, default = "privilegiado") - O método de atribuição do rótulo no documento. Indica se a atribuição do rótulo foi feita automaticamente, padrão ou como uma operação privilegiada (equivalente a uma operação de administrador). Os valores possíveis são padrão, privilegiado, automático e valor futuro desconhecido.
• justificationText(string, default = "Alterado por MCPServer") – Opcional. Texto de justificação para fins de auditoria, e é necessário ao fazer downgrade ou remover uma etiqueta.

getDefaultDocumentLibraryInSite

Obtenha a Biblioteca de Documentos por defeito (também chamada Drive) num site SharePoint. Se não especificares um site, o site raiz é usado.

Parâmetros necessários

None

Parâmetros opcionais

• SiteId: ID do site (por defeito: root)

Funcionalidades principais

Gestão de pastas

• Criar pastas com resolução automática de conflitos de nomeação
• Enumerar crianças de pastas (top 20)
• Mover ficheiros entre pastas (dentro do mesmo site)

Operações com ficheiros

• Criar e carregar pequenos ficheiros de texto (< 5MB)
• Leia e descarregue ficheiros de texto
• Cópia de segurança de ficheiros e pastas
• Cópia de segurança de ficheiros e pastas
• Obtenha metadados de ficheiros e pastas por ID ou URL

Descoberta do sítio e da biblioteca

• Encontre sites SharePoint por consulta de pesquisa
• Listar bibliotecas de documentos num site
• Obter biblioteca de documentos por defeito

Partilha e permissões

• Partilhar ficheiros e pastas com atribuições de funções
• Enviar convites de partilha com mensagens personalizadas
• Controlo de acesso através de permissões explícitas

Segurança e conformidade

• Definir etiquetas de sensibilidade nos ficheiros
• Suporte para métodos privilegiados, padrão e de atribuição automática
• Texto de justificação para auditoria de conformidade

Integração

• Suporte ao OneDrive e SharePoint Online
• Ligação ao servidor específica do inquilino
• Abstração DriveItem para ficheiros e pastas

Notas

1. A Biblioteca de Documentos Padrão é 'eu' (OneDrive do utilizador)
2. A pasta parental por defeito é 'root'
3. Conflitos entre nomes de pastas resolvidos com sufixos numéricos
4. Movimentos de ficheiros limitados a menos de 5 MB e dentro do mesmo site
5. Partilhar URLs requer permissões de acesso explícitas
6. Os DriveItems representam tanto ficheiros como pastas
7. Limite Top 20 na enumeração dos filhos das pastas