Agora que você conectou o servidor MCP do Document360 aos seus assistentes de IA, vamos explorar como os assistentes de IA podem usar ferramentas MCP para buscar, recuperar, criar, atualizar, gerenciar fluxos de trabalho e publicar conteúdo na sua base de conhecimento. Eles também podem manter termos de glossário, gerenciar lembretes de revisão de artigos, realizar suas tarefas atribuídas e enviar feedback de artigos.
Essas ferramentas funcionam em conjunto por meio de prompts, permitindo tarefas de documentação em múltiplas etapas com uma única instrução. Por exemplo, um assistente de IA pode buscar artigos existentes, recuperar detalhes de categorias, criar nova documentação, atualizar conteúdo existente, mover conteúdo por etapas de fluxo de trabalho e publicá-lo no site da sua base de conhecimento, tudo com base na estrutura do projeto e nas permissões. Entender como essas ferramentas funcionam ajuda a criar prompts mais eficazes e a construir fluxos de trabalho de documentação eficientes.
Quando o Document360 lança novas ferramentas MCP, seu assistente de IA não as detecta automaticamente. Atualize a lista de ferramentas no seu assistente de IA, ou desconecte e reconecte o conector do Document360 para começar a usá-las.
As ferramentas MCP funcionam apenas com o conteúdo do seu espaço de trabalho da base de conhecimento. Elas não buscam, recuperam, criam ou atualizam conteúdo dentro de um espaço de trabalho de documentação da API (referências da API geradas a partir de uma especificação OpenAPI ou Postman). Para trabalhar com o conteúdo da documentação da API, use o portal Document360 ou a API padrão do Cliente.
Ferramentas MCP
Ferramentas de busca e recuperação
| Ferramenta | O que ele faz | Use isso para |
|---|---|---|
document360-mcp-search |
Realiza uma busca semântica em todo o seu projeto de base de conhecimento. Corresponde por significado, não pela redação exata. Pesquisa todas as versões do projeto por padrão, ou uma versão específica quando necessário. | Descubra artigos relacionados, explore um tema ou encontre documentação quando você não souber exatamente a frase usada |
document360-mcp-find-text |
Encontra uma palavra ou frase exata em qualquer lugar da sua documentação e retorna todas as categorias de artigos e páginas que a contêm, com seus URLs públicos. | Encontre cada documento contendo um termo exato, recursos de conteúdo ou trecho de código antes de uma atualização em massa |
document360-mcp-list-documents |
Lista artigos e categorias de páginas usando filtros como versão, idioma, categoria, status, tags, rótulos ou data de atualização. | Construa uma lista de avaliações para um lançamento, audite uma categoria ou encontre tudo atualizado desde uma data |
document360-mcp-get-article |
Recupera o conteúdo completo de qualquer artigo usando seu ID ou URL. Funciona em vários idiomas e permite acessar versões publicadas e rascunhos. | Leia artigos existentes, revise o conteúdo preliminar, busque artigos antes de atualizar |
document360-mcp-get-categories |
Recupera a estrutura completa de categorias de uma versão selecionada do projeto, incluindo categorias filhos e artigos associados. | Navegue pela hierarquia da base de conhecimento, encontre IDs de categoria, entenda a estrutura da documentação |
document360-mcp-get-category |
Recupera tudo sobre uma categoria específica, seu conteúdo, subcategorias e artigos associados usando o ID da categoria. | Inspecionar uma categoria profundamente, ler o conteúdo da página da categoria, validar a categoria antes das atualizações |
document360-mcp-get-project-versions |
Lista todas as versões disponíveis do seu projeto junto com seus identificadores para que você possa executar operações específicas de cada versão com precisão. | Selecione a versão correta, crie prompts conscientes da versão, recupere IDs de versão válidos |
document360-mcp-get-workflow-statuses |
Lista os status do fluxo de trabalho configurados para o projeto, junto com seus identificadores e flags. | Descubra os status de fluxo de trabalho disponíveis, recupere os IDs de status antes de passar o conteúdo pelas etapas de revisão |
document360-mcp-get-workflow-assignees |
Lista os usuários e grupos que podem ser atribuídos ao fluxo de trabalho de um documento específico. | Encontre IDs válidos de cedentes antes de atribuir uma etapa do fluxo de trabalho, identifique quem pode revisar um documento |
document360-mcp-list-glossary-terms |
Lista os termos do glossário no seu projeto, incluindo a definição de cada termo e as variantes linguísticas. Você pode filtrar por termos globais ou em nível linguístico, idioma ou texto de busca. | Verifique se um termo já está definido, revise as definições do glossário, encontre um termo antes de inseri-lo em um artigo |
document360-mcp-list-review-reminders |
Lista os artigos e categorias de páginas em um espaço de trabalho que tenham um lembrete de avaliação, com a data de revisão mais antiga primeiro. Você pode filtrar por estado (obsoleto ou agendado), faixa de datas de revisão e idioma. | Encontre conteúdo que precise de revisão agora, planeje as próximas resenhas, verifique quais artigos devem ser entregues antes do lançamento |
document360-mcp-get-my-tasks |
Lista as tarefas atribuídas a você em um espaço de trabalho, incluindo tarefas de fluxo de trabalho, feedback dos leitores e lembretes de revisão. Essa é a mesma lista que você vê na página de Tarefas do portal. | Veja o que está atrasado ou vence esta semana, faça triagem do seu trabalho, encontre o ID da tarefa antes de agir em uma tarefa |
Qual ferramenta de busca você deve usar? Depende do que você está procurando:
- Se você souber o assunto , mas não as palavras exatas, use
document360-mcp-search. Por exemplo, "o que nossos documentos dizem sobre redefinir uma senha?" - Se você souber a palavra ou frase exata que deseja encontrar, use
document360-mcp-find-text. Por exemplo, para encontrar todo artigo que contenha{{old_api_key}}. - Se você não tem um termo de busca e só quer uma lista de documentos, use
document360-mcp-list-documents. Por exemplo, todo artigo de uma categoria que foi atualizado no mês passado.
Ferramentas de escrita
| Ferramenta | O que ele faz | Use isso para |
|---|---|---|
document360-mcp-create-article |
Cria um novo artigo dentro de uma categoria específica e uma versão do projeto apoiando conteúdo estruturado. | Crie nova documentação na categoria certa, relabore artigos de ajuda faltantes, gere primeiros rascunhos a partir de prompts |
document360-mcp-update-article |
Atualiza um artigo existente preservando sua estrutura e formatação. Construído para atualizações parciais para que você possa revisar uma seção sem mexer no restante do artigo. | Atualize documentação desatualizada, revise artigos durante as atualizações do produto, reescreva seções específicas sem afetar o restante |
document360-mcp-create-category |
Cria uma nova categoria dentro de uma versão selecionada do projeto. Suporta estruturas aninhadas para que você possa construir subcategorias conforme seu conteúdo cresce. | Adicionar novas seções de documentação, criar subcategorias para novos recursos, organizar o conteúdo em novas estruturas |
document360-mcp-update-category |
Atualiza propriedades de categoria, como nome, posição, hierarquia ou visibilidade. | Renomear categorias, reorganizar a hierarquia, melhorar a estrutura |
document360-mcp-update-category-content |
Atualiza o conteúdo das páginas de categorias preservando a estrutura existente. | Atualize o conteúdo da página ou do índice das categorias, revise a visão geral da categoria ou seções introdutórias, atualize as orientações em nível de categoria sem afetar o restante da estrutura |
document360-mcp-set-workflow-status |
Define o status do fluxo de trabalho de uma categoria de artigo ou página, com data de entrega opcional, comentário e designados. | Avance o conteúdo pelas etapas de revisão, designe revisores, defina prazos para tarefas de fluxo de trabalho |
document360-mcp-publish-article |
Publica um artigo promovendo seu rascunho mais recente para a versão ao vivo. | Faça um rascunho de artigo ativo no site da base de conhecimento após criá-lo ou atualizá-lo |
document360-mcp-unpublish-article |
Despublica um artigo e o remove do site da base de conhecimento ativa. O conteúdo é preservado e pode ser republicado. | Tire um artigo desatualizado ou incorreto do ar sem apagar |
document360-mcp-publish-category |
Publica o conteúdo mais recente de rascunho da categoria de página até a versão ao vivo. | Crie uma categoria de página ativa após atualizar seu conteúdo |
document360-mcp-unpublish-category |
Despublica uma categoria de Página e a remove do site da base de conhecimento ativa. O conteúdo é preservado e pode ser republicado. | Remova uma categoria de Página do site da base de conhecimento ativa sem excluí-la |
document360-mcp-create-glossary-term |
Adiciona um novo termo ao seu glossário, seja como um termo global compartilhado entre todos os idiomas ou como um termo em nível linguístico para um idioma. | Definir novos termos de produto, adicionar entradas de glossário faltantes, construir um glossário a partir da documentação existente |
document360-mcp-update-glossary-term |
Atualiza o nome, termo ou definição de um termo do glossário existente. Apenas os campos que você altera são atualizados. Para termos em nível de idioma, você pode atualizar um idioma ou adicionar um novo. | Revise definições desatualizadas, adicione uma definição em outro idioma, corrija a redação de um termo |
document360-mcp-set-article-review-reminder |
Agenda um lembrete de revisão em um artigo, sinaliza para revisão agora ou remove o lembrete. | Agende a próxima revisão após atualizar um artigo, sinalize um artigo como precisando de revisão e remova um lembrete que não é mais necessário |
document360-mcp-snooze-task |
Ele adia uma das suas tarefas até uma data específica, ou traz uma tarefa que estava soneca. | Adie uma tarefa que você ainda não pode executar, traga de volta uma tarefa que está sonecada mais cedo |
document360-mcp-mark-task-done |
Marca uma das suas tarefas de fluxo de trabalho como concluída, assim como Marca como concluída na página de Tarefas . | Confirme que você concluiu sua revisão de um artigo |
document360-mcp-update-feedback-status |
Atualiza o status, o destinatário ou a nota interna do feedback do leitor atribuída a você. Você também pode notificar o leitor sobre a mudança. | Dê feedback próximo após corrigir um artigo, dê feedback a um colega, adicione uma nota interna |
document360-mcp-send-article-feedback |
Envia feedback sobre um artigo publicado para sua equipe de documentação, por exemplo, quando o conteúdo está pouco claro, está desatualizado, falta de informação, é irrelevante ou tem um link quebrado. O feedback aparece no gerenciador de Feedback. | Reporte um problema encontrado em um artigo enquanto usa seu assistente de IA |
- As ferramentas do Glossário estão disponíveis apenas quando o recurso Glossário está incluído no plano do seu projeto.
document360-mcp-update-feedback-statusestá disponível apenas quando o gerente de Feedback está incluído no plano do seu projeto. - Termos do glossário não podem ser excluídos pelo MCP, e você não pode acionar a tradução do glossário a partir do MCP. Para termos em nível de idioma, adicione cada idioma separadamente usando
document360-mcp-update-glossary-term. - Renomear um termo de glossário não atualiza os artigos que já o utilizam.
document360-mcp-mark-task-donenão altera o status do fluxo de trabalho. Para mover o artigo para o próximo status, usedocument360-mcp-set-workflow-status.
Contas de Leitor e Revisor: As ferramentas MCP seguem o papel e o acesso ao conteúdo da conta conectada, então seu assistente de IA só pode realizar as ações que você tem permissão no portal.
- Contas de leitores podem usar
document360-mcp-send-article-feedback, mas nenhuma outra ferramenta de escrita. Leitores também não podem usardocument360-mcp-list-glossary-terms,document360-mcp-list-review-reminders, oudocument360-mcp-get-my-tasks. - Contas revisores não podem usar
document360-mcp-create-glossary-term,document360-mcp-update-glossary-term,document360-mcp-set-article-review-reminder, oudocument360-mcp-update-feedback-status.
Limites de taxa
As solicitações MCP estão sujeitas a limites de taxa baseados no seu plano Document360. Os limites são aplicados por usuário, por projeto, em todas as chamadas de ferramentas MCP dentro de uma janela fixa de um minuto. As operações de leitura e escrita compartilham o mesmo limite, então buscar, recuperar, criar e atualizar chamadas são todas extraídas de um único pool. O limite de taxa depende do seu plano: projetos de plano de negócios são limitados a 60 solicitações por minuto por usuário e projetos de plano empresarial são limitados a 100 solicitações por minuto por usuário.
Esses limites ajudam a garantir desempenho confiável e uso justo em todos os fluxos de trabalho de documentação. Se você ultrapassar o limite de taxa, as requisições subsequentes podem ser retardadas até o início da próxima janela de um minuto.
Isso pode acontecer quando:
- Executando prompts automáticos frequentes
- Realizando buscas repetidas em rápida sucessão
- Execução de múltiplas operações de criação ou atualização ao mesmo tempo
Se seu fluxo de trabalho exigir um limite maior, entre em contato com seu Gerente de Sucesso do Cliente ou support@document360.com. Limites mais altos podem ser configurados de acordo com suas necessidades e podem envolver um custo adicional.
Melhores práticas para gerenciar limites de solicitações MCP
Para evitar limitação:
- Espaça pedidos frequentes ou automatizados
- Divida grandes fluxos de trabalho em sequências menores de prompts
- Reutilizar o contexto da categoria ou artigo recuperado sempre que possível
- Evite buscas paralelas repetidas em múltiplas versões
Isso ajuda a manter uma experiência MCP mais suave e reduz a probabilidade de interrupções no fluxo de trabalho.