Referência ao Microsoft SharePoint e OneDrive MCP Server

Visão geral

Ferramentas disponíveis

CreateFolder

Cria uma nova pasta dentro de uma Biblioteca de Documentos especificada como filho da pasta pai especificada. Se você não especificar uma Biblioteca de Documentos, o servidor usa o OneDrive do usuário. Se você não especificar 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 obrigatórios

• folderName(string) – Nome da pasta a ser criada. Se uma pasta com o mesmo nome já existir, 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 você deseja criar a pasta. Se você quiser criar uma pasta no drive do usuário ou no OneDrive dele, como "meu drive" ou "meu onedrive", envie "me" como o documentLibraryId.

Parâmetros opcionais:

• parentFolderId(string, default = "root") – ID da pasta pai sob a qual a nova pasta será criada. O padrão é a raiz da biblioteca de documentos se não especificado.

findSite

Encontra sites do SharePoint acessados pelo usuário. Essa ferramenta pode encontrar um site específico com base em uma consulta de busca que você fornecer, ou encontrar os 20 sites mais relevantes acessíveis pelo usuário, caso você não forneça uma consulta de busca.

Parâmetros obrigatórios

Nenhum

Parâmetros opcionais:

• searchQuery(string, default = null) – Consulta de busca que pode ser o nome inteiro ou parcial do site. Fornecer uma consulta de busca ajuda a buscar um site de forma eficiente, mas somente se o usuário estiver procurando um site específico. Por exemplo, se o usuário pedir por um site chamado xyz, você passaria xyz por .searchQuery Se o usuário apenas pedir "meus sites", você deixa esse parâmetro vazio.

listaDocumentBibliotecasInSite

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

Parâmetros obrigatórios

Nenhum

Parâmetros opcionais:

• SiteId: ID do site (padrão: root)

FindFileOrFolder

Encontra um arquivo ou uma pasta (também chamada de DriveItem) que o usuário pode acessar ao passar uma consulta de busca.

Parâmetros obrigatórios

• searchQuery: Consulta de busca que pode ser o nome do arquivo inteiro ou parcial

renameFileOrFolder

Renomeie um arquivo ou uma pasta (também chamada de DriveItems) dentro da Biblioteca de Documentos especificada. Nota: O novo nome deve estar em conformidade com as convenções de nomeação.

Parâmetros obrigatórios

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

deleteFileOrFolder

Exclua um arquivo ou uma pasta da Biblioteca de Documentos especificada.

Parâmetros obrigatórios

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

readSmallTextFile

Leia (baixe) um arquivo de texto de uma Biblioteca de Documentos específica. Se você não especificar uma Biblioteca de Documentos, o OneDrive do usuário é usado. Você precisa fornecer um fileId (driveItemId de um arquivo) para identificar e baixar o arquivo.

Parâmetros obrigatórios

• fileId(string)
• documentLibraryId(string) – Id da Biblioteca de Documentos (também chamada de Drive) do arquivo que você deseja ler. Se o usuário pedir para você ler ou baixar um arquivo no drive dele ou no Onedrive, por exemplo - Leia um arquivo em "my drive", leia um arquivo em "my onedrive", você deve enviar "me" como documentLibraryId.

moveSmallFile

Mova um arquivo localizado na Biblioteca de Documentos especificada para outra pasta. Essa ferramenta só suporta mover arquivos com menos de 5 MB e movimentos que estejam dentro do mesmo site. Você não pode mover arquivos entre Drives usando essa solicitação.

Parâmetros obrigatórios

• documentLibraryId(string) – Id da Biblioteca de Documentos (também chamada de Drive) do arquivo que você deseja mover. Se o usuário pedir para mover um arquivo no drive dele ou no Onedrive, por exemplo - mova um arquivo em "meu drive", mova um arquivo em "meu onedrive", você deve enviar "me" como documentLibraryId.
• fileId(string) – Id do arquivo a ser movido
• newParentFolderId(string) – O ID da pasta de destino para mover o arquivo. Deve estar na mesma biblioteca de documentos da localização original do arquivo.

getFileOrFolderMetadata

Obtenha metadados de um arquivo ou pasta da Biblioteca de Documentos especificada em um site SharePoint.

Parâmetros obrigatórios

• FileOrFolderId(string) – Id de um arquivo ou pasta. Eles também são chamados de DriveItems. E o Id deles também pode ser chamado às vezes de driveItemId.
• documentLibraryId(string) – Id da Biblioteca de Documentos (também chamada de Drive) do arquivo ou pasta cujos metadados você precisa de fornecer. Se o usuário pedir para você pegar um arquivo ou pasta no drive dele ou no Onedrive, por exemplo - "Obter metadados de um arquivo no meu drive" ou "Obter metadados de uma pasta no meu Onedrive", você deve enviar "me" como documentLibraryId.

createSmallTextFile

Crie ou envie um arquivo de texto menor que 5 MB para uma Biblioteca de Documentos específica. Se você não especificar uma Biblioteca de Documentos, o OneDrive do usuário é usado. Você pode carregar um arquivo específico: Se você não especificar uma pasta, o arquivo é enviado para a pasta raiz.

Parâmetros obrigatórios

• Nome do arquivo (string) – Nome do arquivo a ser criado
• contentText (string) – Conteúdo do texto do arquivo a ser criado
• documentLibraryId (string) – ID da Biblioteca de Documentos (também chamada de Drive) para o arquivo. Se um usuário pedir para você criar um arquivo no drive dele ou no OneDrive dele, como "criar um arquivo no meu drive" ou "criar um arquivo no meu OneDrive", envie "me" como o documentLibraryId.

Parâmetros opcionais:

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

getFileOrFolderMetadataByUrl

Obtenha metadados de um arquivo ou pasta a partir de uma URL de compartilhamento. Apenas usuários com permissões explícitas para acessar o arquivo podem obter os metadados.

Parâmetros obrigatórios

• fileOrFolderUrl:(string) – URL do Arquivo ou Pasta (também chamado de DriveItems). A URL não é resgatada para compartilhá-la com o usuário; Eles já devem ter acesso explícito ao arquivo.

shareFileOrFolder

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

Parâmetros obrigatórios

• documentLibraryId: ID da Biblioteca do Documento (string, Obrigatório)
• fileOrFolderId: ID de arquivo ou pasta (string, Required)
• recipientEmails:(string[], Obrigatório) – Endereços de e-mail dos destinatários a serem convidados. É necessário pelo menos um e-mail do destinatário.

Parâmetros opcionais:

• roles(string[]) – Papéis a atribuir aos destinatários. Valores aceitos: ler, escrever (escrever concessões tanto para leitura quanto para acesso por escrita). o padrão é se não for especificado.
• sendInvitation(bool, default = true) – Indica se deve enviar um convite de compartilhamento. O padrão é se não for especificado.
• message(string, default = "Aqui está o arquivo no qual estamos colaborando.") – Mensagem personalizada para incluir no e-mail de convite. O padrão é uma mensagem padrão se não for especificado.

getFolderChildren

Enumera os 20 principais arquivos e pastas dentro de uma pasta pai especificada em uma Biblioteca de Documentos. Se você não especificar uma Biblioteca de Documentos, o OneDrive do usuário é usado.

Parâmetros obrigatórios

• documentLibraryId(string) – ID da Biblioteca de Documentos (também chamada de Drive) para a pasta pai. Se um usuário pedir para você colocar arquivos em uma pasta no drive dele ou no OneDrive dele, como "obter arquivos em uma pasta no meu drive" ou "colocar arquivos em uma pasta no meu OneDrive", envie "me" como o documentLibraryId.

Parâmetros opcionais:

• parentFolderId:(string, default = "root") – ID da pasta pai (DriveItem) cujos arquivos e pastas estão listados. O padrão é para a pasta raiz da Biblioteca de Documentos se não especificado.

Eco

O cliente envia uma mensagem para o servidor

Parâmetros obrigatórios

• mensagem: Mensagem para enviar de volta

setSensitivityLabelOnFile

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

Parâmetros obrigatórios

• documentLibraryId(string) – O ID da biblioteca de documentos, também conhecido como driveId, da biblioteca de documentos
• fileId(string) – O ID do arquivo, também conhecido como driveItemId, do arquivo
• sensitivityLabelId(string) – Obrigatório. ID do rótulo de sensibilidade a ser atribuído, 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 justificativa para fins de auditoria, e é necessário ao rebaixar ou remover um rótulo.

getDefaultDocumentLibraryInSite

Obtenha a Biblioteca de Documentos padrão (também chamada de Drive) em um site do SharePoint. Se você não especificar um site, o site raiz é usado.

Parâmetros obrigatórios

Nenhum

Parâmetros opcionais:

• SiteId: ID do site (padrão: root)

Recursos principais

Gerenciamento de pastas

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

Operações de aquivo

• Criar e enviar pequenos arquivos de texto (< 5MB)
• Leia e baixe arquivos de texto
• Renomear ou mover arquivos e pastas
• Excluir arquivos ou pastas
• Obtenha metadados de arquivos e pastas por ID ou URL

Descoberta de sítios e bibliotecas

• Encontre sites SharePoint por meio de consulta de busca
• Listar bibliotecas de documentos em um site
• Obtenha a biblioteca de documentos padrão

Compartilhamento e permissões

• Compartilhe arquivos e pastas com atribuições de funções
• Envie convites de compartilhamento com mensagens personalizadas
• Controle de acesso por meio de permissões explícitas

Segurança e conformidade

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

Integração

• Suporte ao OneDrive e SharePoint Online
• Conexão de servidor específica para locatários
• Abstração DriveItem para arquivos e pastas

Notes

1. A Biblioteca de Documentos Padrão é 'eu' (OneDrive do usuário)
2. A pasta pai padrão é 'root'
3. Conflitos de nomes de pasta resolvidos com sufixos numéricos
4. Movimentos de arquivo limitados a menos de 5 MB e dentro do mesmo local
5. Compartilhamento de URLs requer permissões de acesso explícitas
6. DriveItems representam tanto arquivos quanto pastas
7. Limite Top 20 na enumeração dos filhos de pastas