Referência do Work IQ SharePoint (prévia)

Importante

• Este é um recurso em versão preliminar.
• As versões prévias do recurso não foram criadas para uso em ambientes de produção e podem ter funcionalidade restrita. Esses recursos estão sujeitos a termos de uso suplementares e são disponibilizados antes de um lançamento oficial, de maneira que os clientes possam ter acesso antecipado e fazer comentários.

Visão geral

ID de servidor	Nome de exibição	Descrição
mcp_SharePointRemoteServer	SharePoint do IQ de Trabalho	Servidor MCP para operações de SharePoint. Use este servidor para gerenciar sites, listas, itens de lista, colunas, bibliotecas de documentos, arquivos, pastas e compartilhamento de arquivos. As operações de arquivo são limitadas a ≤5 MB.

Observação

• As conexões existentes que usam versões anteriores de servidores MCP da Microsoft, como o servidor MCP do Microsoft Teams, permanecem com suporte.
• Para todas as novas conexões, use os servidores MCP mais recentes do Work IQ, como o Work IQ Teams.

Ferramentas disponíveis

findSite

Localize sites do SharePoint acessíveis ao usuário. Retorna sites específicos que correspondem a uma consulta de pesquisa ou aos 20 principais sites relevantes se nenhuma consulta for fornecida.

Parâmetros opcionais:

• Searchquery: Consulta de pesquisa (nome inteiro ou parcial do site). Omitir para retornar os 20 principais sites acessíveis

getSiteByPath

Resolva um site do SharePoint usando seu nome de host exato e o caminho relativo ao servidor. Use somente quando você tiver a estrutura de URL do site completa. Use findSite quando apenas um nome de site for conhecido.

Parâmetros requeridos:

• Hostname: Nome exato do host (por exemplo, 'contoso.sharepoint.com')
• serverRelativePath: Caminho relativo ao servidor (por exemplo, 'sites/Marketing'). A barra principal é opcional.

listSubsites (listarSubsites)

Liste todos os subsites (sites filho) de um site do SharePoint.

Parâmetros requeridos:

• Siteid: ID do site pai do SharePoint (formato: 'hostname,siteCollectionId,webId')

listarBibliotecasDeDocumentosNoSite

Listar bibliotecas de documentos (repositórios) no site do SharePoint especificado.

Parâmetros opcionais:

• Siteid: ID do site do SharePoint (padrão: 'raiz')

obterBibliotecaDeDocumentosPadrãoNoSite

Obtenha a biblioteca padrão de documentos (drive) em um site do SharePoint.

Parâmetros opcionais:

• Siteid: ID do site do SharePoint (padrão: 'raiz')

getFolderChildren

Enumera os 20 principais arquivos e pastas (DriveItems) contidos em uma pasta pai especificada em uma biblioteca de documentos (drive).

Parâmetros requeridos:

• documentLibraryId: ID da biblioteca de documentos (drive)

Parâmetros opcionais:

• Parentfolderid: ID da pasta pai (padrão: 'raiz')

FindFileOrFolder

Localiza um arquivo ou pasta (DriveItem) acessível ao usuário por consulta de pesquisa. Pesquisa em todos os sites e bibliotecas de documentos às quais o usuário tem acesso.

Parâmetros requeridos:

• Searchquery: Consulta de pesquisa (nome de arquivo inteiro ou parcial)

getFileOrFolderMetadata

Obtenha o metadado de um arquivo ou pasta (DriveItem) de uma biblioteca de documentos especificada no SharePoint.

Parâmetros requeridos:

• fileOrFolderId: ID do arquivo ou pasta (DriveItem)
• documentLibraryId: ID da biblioteca de documentos (drive)

getFileOrFolderMetadataByUrl

Obtenha metadados de um arquivo ou pasta de uma URL de compartilhamento. Somente usuários com permissões explícitas existentes para acessar o arquivo serão permitidos.

Parâmetros requeridos:

• fileOrFolderUrl: URL do arquivo ou pasta. A URL não será resgatada para compartilhá-la com o usuário; eles já devem ter acesso explícito

readSmallTextFile

Ler um arquivo de texto com menos de 5 MB de uma biblioteca de documentos específica (drive).

Parâmetros requeridos:

• Idarquivo: ID do arquivo (DriveItem) para leitura/download
• documentLibraryId: ID da biblioteca de documentos (drive)

readSmallBinaryFile

Leia um arquivo binário de tamanho menor que 5 MB de uma biblioteca de documentos específica (drive). O conteúdo do arquivo é retornado como uma cadeia de caracteres codificada em base64.

Parâmetros requeridos:

• Idarquivo: ID do arquivo (DriveItem) para leitura/download
• documentLibraryId: ID da biblioteca de documentos (drive)

createSmallTextFile

Crie ou carregue um arquivo de texto com tamanho menor que 5MB para uma biblioteca de documentos específica.

Parâmetros requeridos:

• Filename: Nome do arquivo, incluindo extensão
• Contenttext: Conteúdo de texto do arquivo
• documentLibraryId: ID da biblioteca de documentos (drive)

Parâmetros opcionais:

• Parentfolderid: ID da pasta pai (padrão: 'raiz')

createSmallBinaryFile

Crie um arquivo binário de tamanho inferior a 5 MB codificando seu conteúdo em base64 para uma biblioteca de documentos (unidade) específica.

Parâmetros requeridos:

• Filename: Nome do arquivo, incluindo extensão
• base64Content: Conteúdo do arquivo binário codificado como uma cadeia de caracteres base64
• documentLibraryId: ID da biblioteca de documentos (drive)

Parâmetros opcionais:

• Parentfolderid: ID da pasta pai (padrão: 'raiz')

criarPasta

Crie uma nova pasta (DriveItem) em uma biblioteca de documentos (drive) especificada. Se existir uma pasta com o mesmo nome, um sufixo numérico será adicionado (por exemplo, NewFolder (1)).

Parâmetros requeridos:

• Foldername: Nome da pasta
• documentLibraryId: ID da biblioteca de documentos (drive)

Parâmetros opcionais:

• Parentfolderid: ID da pasta pai (padrão: 'raiz')

renomearArquivoOuPasta

Renomeie um arquivo ou pasta (item do drive) em uma biblioteca de documentos (drive) especificada. O novo nome deve estar em conformidade com as convenções de nomenclatura.

Parâmetros requeridos:

• documentLibraryId: ID da biblioteca de documentos (drive)
• fileOrFolderId: ID do arquivo ou pasta a ser renomeada
• newFileOrFolderName: O novo nome

Parâmetros opcionais:

• Etag: ETag para controle de simultaneidade

deleteFileOrFolder

Exclua um arquivo ou pasta (DriveItem) de uma biblioteca de documentos (drive) especificada.

Parâmetros requeridos:

• documentLibraryId: ID da biblioteca de documentos (drive)
• fileOrFolderId: ID do arquivo ou pasta a ser excluída

Parâmetros opcionais:

• Etag: ETag para controle de simultaneidade

moveSmallFile

Mova um arquivo (DriveItem) para outra pasta na mesma biblioteca de documentos. Só dá suporte a arquivos com menos de 5 MB. Não é possível mover entre unidades.

Parâmetros requeridos:

• documentLibraryId: ID da biblioteca de documentos (drive)
• Idarquivo: ID do arquivo a ser movido
• newParentFolderId: ID da pasta de destino (deve estar na mesma biblioteca de documentos)

Parâmetros opcionais:

• Etag: ETag para controle de simultaneidade

copyFileOrFolder

Copie um arquivo ou pasta (DriveItem) para uma pasta de destino. Dá suporte à cópia em diferentes bibliotecas de documentos no SharePoint. Esta operação é assíncrona; use checkOperationStatus para monitorar o progresso.

Parâmetros requeridos:

• sourcedoclibid: ID da biblioteca de documentos de origem (disco)
• sourcefileid: ID do arquivo de origem ou pasta a ser copiada
• destdoclibid: ID da biblioteca de documentos de destino (drive)
• destfolderid: ID da pasta de destino (deve existir)

Parâmetros opcionais:

• newfilename: Novo nome para o item copiado

checkOperationStatus (verificarStatusDaOperação)

Verifique o status de uma operação assíncrona (como uma cópia) usando o token de operação retornado da operação original.

Parâmetros requeridos:

• operationToken: O token de operação retornado de uma operação assíncrona como copyFileOrFolder

carregarArquivoDeUrl

Carregue um arquivo de um URL do SharePoint ou do OneDrive para uma pasta de destino em uma biblioteca de documentos (armazenamento). O arquivo é copiado da URL de origem; nenhuma alteração é feita no original.

Parâmetros requeridos:

• sourceUrl: URL de origem (deve ser uma URL válida do SharePoint ou do OneDrive)
• destinationDocumentLibraryId: ID da biblioteca de documentos de destino. Use 'me' no OneDrive do usuário

Parâmetros opcionais:

• destinationFolderId: ID da pasta de destino (padrão: 'raiz')
• Nome do arquivo: Novo nome de arquivo; padrão é o nome de arquivo original

compartilharArquivoOuPasta

Envia um convite de compartilhamento para conceder permissões de leitura/gravação em um arquivo ou pasta (DriveItem) em uma biblioteca de documentos (unidade) especificada.

Parâmetros requeridos:

• documentLibraryId: ID da biblioteca de documentos (drive)
• fileOrFolderId: ID do arquivo ou pasta a ser compartilhada
• recipientEmails: Matriz de endereços de email de destinatários
• Funções: Array de funções: 'read', 'write' (write concede leitura e write)

Parâmetros opcionais:

• Mensagem: Mensagem personalizada para o email de convite (padrão: 'Aqui está o arquivo no qual estamos colaborando.')
• sendInvitation: Se é necessário enviar um convite de compartilhamento (padrão: true)

definirEtiquetaDeSensibilidadeNoArquivo

Defina o rótulo de confidencialidade de um arquivo da biblioteca de documentos (unidade) especificada.

Parâmetros requeridos:

• documentLibraryId: ID da biblioteca de documentos (drive)
• Idarquivo: A driveItemId do arquivo
• sensitivityLabelId: ID do rótulo de confidencialidade ou cadeia de caracteres vazia para remover

Parâmetros opcionais:

• assignmentMethod: Método de atribuição: 'standard', 'privileged', 'auto' ou 'unknownFutureValue' (padrão: 'privileged')
• justificationText: Texto de justificativa para auditoria; necessário ao fazer downgrade ou remoção (padrão: 'Alterado pelo MCPServer')

listarListas

Obtenha todas as listas do SharePoint disponíveis em um site específico. Use para descobrir quais listas existem em um site.

Parâmetros requeridos:

• Siteid: ID do site do SharePoint (formato: 'hostname,siteCollectionId,webId')

createList

Crie uma nova lista do SharePoint em um site.

Parâmetros requeridos:

• Siteid: ID do site do SharePoint
• Displayname: Nome de exibição da nova lista

Parâmetros opcionais:

• Colunas: Conjunto de colunas como pares chave-valor: [{ Key: 'JobTitle', Value: 'text' }]. Tipos válidos: texto, textoMultilinha, número, booleano, dataHora, escolha, pesquisa, pessoaOuGrupo, hiperlink, moeda, calculado
• Modelo: Tipo de modelo de lista (padrão: 'genericList'). Opções: GenericList, DocumentLibrary, Eventos, Tarefas, Comunicados, Contatos, Links, Pesquisa, IssueTracking, DiscussionBoard

excluirLista

Exclua uma lista do SharePoint de um site. Exclui todo o contêiner de lista e todos os itens dentro dele. Não pode ser desfeito.

Parâmetros requeridos:

• Siteid: ID do site do SharePoint
• Listid: ID da lista a ser excluída

Parâmetros opcionais:

• Etag: ETag para controle de simultaneidade

enviarConviteParaLista

Envia um convite de compartilhamento para conceder permissões em uma lista do SharePoint.

Parâmetros requeridos:

• Listid: ID da lista do SharePoint a ser compartilhada
• recipientEmails: Matriz de endereços de email de destinatários
• Papel: Função: 'read' (somente exibição), 'contribute' (exibir, adicionar, atualizar, excluir itens), 'editar' (edição completa incluindo estrutura de lista)

Parâmetros opcionais:

• Siteurl: URL do site do SharePoint que contém a lista
• Sendemail: Se deve enviar uma notificação por email (padrão: true)

listListItems

Obtenha itens (linhas/registros) de uma lista específica do SharePoint.

Parâmetros requeridos:

• Siteid: ID do site do SharePoint
• Listid: ID da lista do SharePoint

getListItem

Obtenha um item único (linha/registro) de uma lista do SharePoint pela sua ID.

Parâmetros requeridos:

• Siteid: ID do site do SharePoint
• Listid: ID da lista do SharePoint
• Itemid: ID do item de lista específico

createListItem

Crie um novo item (linha/registro) em uma lista do SharePoint.

Parâmetros requeridos:

• Siteid: ID do site do SharePoint
• Listid: ID da lista do SharePoint
• Campos: Pares chave-valor para os valores dos campos: [{ Key: 'Title', Value: 'Software Engineer' }, { Key: 'Department', Value: 'Engineering' }]. O campo 'Título' normalmente é necessário

atualizarItemDaLista

Atualize um item existente (linha/registro) em uma lista do SharePoint. Somente os campos especificados são atualizados; os campos omitidos mantêm seus valores.

Parâmetros requeridos:

• Siteid: ID do site do SharePoint
• Listid: ID da lista do SharePoint
• Itemid: ID do item a ser atualizado
• Campos: Pares chave-valor de campos a serem atualizados

Parâmetros opcionais:

• Etag: ETag para controle de simultaneidade

deleteListItem

Exclua um item (linha/registro) de uma lista do SharePoint.

Parâmetros requeridos:

• Siteid: ID do site do SharePoint
• Listid: ID da lista do SharePoint
• Itemid: ID do item a ser excluído

Parâmetros opcionais:

• Etag: ETag para controle de simultaneidade

listColumns

Obtenha todas as colunas de uma lista do SharePoint.

Parâmetros requeridos:

• Siteid: ID do site do SharePoint
• Listid: ID da lista do SharePoint

criarColuna

Crie uma nova coluna em uma lista do SharePoint. Dá suporte a muitos tipos de coluna, incluindo texto, número, escolha, data e hora, booleano, usuário, consulta, calculado e muito mais.

Parâmetros requeridos:

• Siteid: ID do site do SharePoint
• Listid: ID da lista do SharePoint
• Nome: Nome da coluna interna (identificador programático)
• columnType: Tipo de coluna: texto, observação, número, inteiro, booleano, dataHora, escolha, múltipla escolha, moeda, pesquisa, usuário, url, calculado, termo, multiterma, local, localização geográfica, miniatura, contador, computado, ID de tipo de conteúdo, arquivo, anexo, guid, escolha de resultado, status de aprovação

Parâmetros opcionais:

• columnProperties: Configurações específicas de tipo (por exemplo, { "maxLength": 255 } para texto, { "choices": ["A","B","C"] } para escolha)
• Descrição: Descrição da coluna
• displayName: Nome de exibição mostrado na UI (o padrão é 'name')
• Obrigatório: Tornar a coluna obrigatória (padrão: falso)
• Escondido: Ocultar coluna nas visualizações (padrão: false)

atualizarColuna

Atualize uma coluna existente em uma lista do SharePoint.

Parâmetros requeridos:

• Siteid: ID do site do SharePoint
• Listid: ID da lista do SharePoint
• Columnid: ID da coluna a ser atualizada

Parâmetros opcionais:

• Columntype: Tipo de coluna (necessário ao fornecer 'columnProperties')
• columnProperties: Propriedades específicas do tipo a serem atualizadas
• Descrição: Nova descrição
• Displayname: Novo nome de exibição
• Ocultar: Ocultar ou mostrar a coluna
• Obrigatório: Defina a coluna como obrigatória ou opcional.

deleteColumn

Exclua uma coluna de uma lista do SharePoint. Aviso: Remove todos os dados armazenados nessa coluna para todos os itens.

Parâmetros requeridos:

• Siteid: ID do site do SharePoint
• Listid: ID da lista do SharePoint
• Columnid: ID da coluna a ser excluída

Características principais

Gerenciamento de site

• Localizar sites por nome ou procurar sites acessíveis
• Obter endereço do site pelo caminho exato do URL
• Listar sites filhos e subsites
• Navegação abrangente da hierarquia de sites

Gerenciamento da biblioteca de documentos

• Listar todas as bibliotecas de documentos em um site
• Obtenha a biblioteca de documentos padrão
• Procurar conteúdo de pasta (até 20 itens)
• Criar e gerenciar estruturas de pastas

Operações de arquivo

• Criar arquivos binários e de texto (≤5 MB)
• Ler texto e arquivos binários (≤5MB)
• Excluir, renomear e mover arquivos
• Copiar arquivos e pastas entre bibliotecas de documentos
• Carregar arquivos de URLs do SharePoint ou do OneDrive
• Pesquisar arquivos e pastas em todos os sites acessíveis
• Obter metadados de arquivo e pasta

Operações assíncronas

• Copiar arquivos e pastas de forma assíncrona entre bibliotecas de documentos
• Verificar o status das operações assíncronas usando tokens de operação

Listar operações

• Criar, ler e excluir listas
• Suporte para vários modelos de lista (genérico, biblioteca de documentos, eventos, tarefas)
• Compartilhar listas com permissões baseadas em função
• Gerenciar itens de lista (criar, ler, atualizar, excluir)

Gerenciamento de colunas

• Criar colunas com uma ampla variedade de tipos (texto, anotação, número, booleano, data e hora, opção, pesquisa, usuário, URL, calculado e muito mais)
• Atualizar propriedades e metadados da coluna
• Configurar requisitos de coluna e visibilidade
• Propriedades específicas de colunas por tipo

Compartilhamento e permissões

• Compartilhar arquivos, pastas e listas com usuários
• Controle de acesso baseado em função (ler, gravar, contribuir, editar)
• Notificações por email para compartilhamento
• Mensagens personalizadas em convites

Segurança e conformidade

• Aplicar e remover rótulos de confidencialidade
• Vários métodos de atribuição (padrão, privilegiado, automático)
• Suporte para justificativas em auditoria
• Controle de simultaneidade com eTags

Observações

• As operações de arquivo são limitadas a ≤5MB para upload e download
• As operações de movimentação funcionam apenas na mesma biblioteca de documentos
• As operações de cópia são assíncronas; usar checkOperationStatus para monitorar o progresso
• Operações de cópia dão suporte à cópia entre bibliotecas no SharePoint
• uploadFileFromUrl requer uma URL de origem válida do SharePoint ou do OneDrive
• As eTags fornecem controle de simultaneidade para atualizações e exclusões
• Sufixo numérico automático para nomes de pasta duplicados
• A exclusão de lista não pode ser desfeita
• A exclusão de coluna remove todos os dados armazenados nessa coluna
• As operações de pesquisa retornam os 20 principais resultados por padrão
• Todas as operações usam a API do Microsoft Graph

Observação

Os nomes e parâmetros de ferramentas MCP estão sujeitos a alterações e dependências codificadas devem ser evitadas. O suporte ao cenário será mantido.