For the complete documentation index, see llms.txt. This page is also available as Markdown.

MCP Server Trigger

Saiba mais sobre o MCP Server Trigger e como utilizá-lo na Digibee Integration Platform.

Visão geral

O MCP Server é um trigger que permite que um pipeline da Digibee receba e processe solicitações provenientes de um cliente MCP (Model Context Protocol).

Ele atua como ponto de entrada para eventos ou ações iniciadas por ferramentas externas conectadas por meio do protocolo MCP, como assistentes de IA ou serviços de automação que se comunicam com a Digibee.

Para que serve

É usado quando você deseja:

  • Permitir que serviços de IA ou externos (como um assistente compatível com MCP) executem uma ação, obtenham mais contexto ou interajam com um pipeline da Digibee.

  • Garantir a aplicação de playbooks e processos de negócio para tornar seu agente mais inteligente.

    • Agentes têm dificuldade em seguir orientações não estruturadas. A Digibee garante a execução correta passo a passo.

  • Garantir que seu agente siga regras e políticas de negócio.

    • Você pode externalizar suas regras em pipelines MCP. Isso garante decisões determinísticas e auditáveis.

Como funciona

  1. O cliente MCP envia uma solicitação que corresponde à configuração do trigger.

  2. O MCP Server Trigger inicia o pipeline e fornece o payload de entrada.

  3. O pipeline executa sua lógica (transformações, integrações, e assim por diante).

  4. O resultado é encapsulado em um objeto content, conforme exigido pelo protocolo oficial do MCP. Isso garante que o agente de IA receba as informações no formato de texto ou imagem esperado.

Campos com assistência de IA

Campos marcados com nesta documentação suportam geração de conteúdo com assistência de IA. Na plataforma, esses campos exibem um botão de brilho () no canto superior direito. Use-o para gerar ou editar o conteúdo do campo a partir de uma descrição em linguagem natural, sem precisar escrevê-lo manualmente.

Para usar o assistente:

  1. Clique no ícone de brilho (). Um painel será aberto para você descrever o que precisa.

  2. Insira sua descrição e clique em Gerar.

  3. Quando a geração for concluída, você pode escolher uma das seguintes opções:

    1. Aplicar: Substitui o conteúdo atual do campo pelo resultado gerado.

    2. Tentar novamente: Retorna ao prompt para repetir a mesma descrição ou testar uma nova.

    3. Fechar: Descarta o resultado e mantém o conteúdo atual do campo.

Configuração das ferramentas

Para começar a configurar o trigger, é necessário adicionar ferramentas. Cada ferramenta exposta por um servidor MCP inclui um conjunto de campos principais que definem sua identidade, propósito, permissões e estrutura de dados.

Adicionando uma nova ferramenta

  1. Acesse a seção Ferramentas do MCP Server.

  2. Clique em Adicionar Ferramentas.

  3. Preencha os campos descritos abaixo.

  4. Após salvar, a ferramenta aparecerá na Lista de Ferramentas, onde você pode adicionar, editar ou excluir entradas.

Campos da ferramenta

Nome da Ferramenta

Identificador exclusivo da ferramenta. Deve ser conciso, descritivo e geralmente utilizar snake_case.

Exemplo: search_web

Descrição

Resumo curto e claro do que a ferramenta faz. Ajuda o modelo e os usuários a entenderem seu propósito.

Exemplo: Executa uma pesquisa na web e retorna os principais resultados.

Escopos

Define as permissões que essa ferramenta requer em tempo de execução. Os escopos são incorporados ao token JWT com escopo quando um agente invoca essa ferramenta. Este campo é opcional. Digite um escopo e pressione Enter ou Tab para adicioná-lo como uma tag.

Exemplo: read:web, write:logs

Configuração de Schema

Você pode definir como sua ferramenta lida com dados de entrada e saída usando JSON Schemas. Esses schemas descrevem a estrutura esperada, os tipos de dados e as regras de validação.

A configuração se aplica a duas seções:

  • Schema de Entrada: Define a estrutura dos dados recebidos pela ferramenta.

  • Schema de Saída: (Opcional) Define a estrutura dos dados retornados pela ferramenta.

Ambos podem ser configurados de duas formas:

Opção 1: Assistente

Use o assistente para orientar sua configuração clicando em Adicionar Propriedade e preenchendo os parâmetros:

  • Nome: Define o nome da propriedade dentro do objeto JSON.

  • Tipo: Especifica o tipo de dado (string, number, boolean, array ou object).

  • Obrigatório: Indica se o campo é obrigatório.

  • Descrição: Descreve o propósito ou significado da propriedade.

  • Valores Enum: (Aplicável apenas ao tipo string) Lista os valores permitidos para a propriedade.

  • Tipo do Item do Array: (Aplicável apenas ao tipo array) Define o tipo de dado dos elementos do array (string, number, boolean ou array).

  • Propriedades do Objeto: (Aplicável apenas ao tipo object) Define o conjunto de propriedades contidas dentro do objeto.

Exemplo: Schema de Entrada

Nome
Tipo
Obrigatório
Descrição
Valores Enum

query

string

Sim

O termo de pesquisa ou palavras-chave a serem buscadas.

limit

number

Não

Número de resultados a serem retornados.

N/A

JSON Schema resultante

Exemplo: Schema de Saída

Nome
Tipo
Obrigatório
Descrição
Tipo do Item do Array

results

array

Não

Lista de URLs correspondentes à consulta de pesquisa.

string

JSON Schema resultante

Opção 2: Schema

Como alternativa, insira o JSON Schema diretamente no campo fornecido.

Configuração de parâmetros

Parâmetro
Descrição
Tipo de dado
Valor padrão

Server Name

Nome do servidor MCP. Usado apenas para referência.

String

N/A

Description

Breve descrição para identificar o servidor MCP.

String

N/A

Maximum Timeout

Tempo máximo (em milissegundos) para o pipeline processar as informações antes de retornar uma resposta. Limite: 900000 ms.

Integer

30000

The Maximum Allowed Request Size In Mb

Tamanho máximo do payload em megabytes. O tamanho máximo configurável é de 5 MB.

Integer

5

External API

Se ativado, o servidor MCP torna-se acessível por meio do gateway externo da Digibee, permitindo comunicação pela Internet pública.

Booleano

true

Internal API

Se ativado, expõe o servidor MCP por meio do gateway interno da Digibee, restringindo o acesso apenas à rede interna. As opções External API e Internal API podem estar ativas simultaneamente.

Booleano

false

API Key

Se ativado, o endpoint só pode ser acessado com uma chave de API configurada na Digibee Integration Platform.

Booleano

false

OAuth2 JWT

Se habilitado, o MCP Server valida access tokens usando OAuth 2.0 com JWT. Para instruções de configuração, consulte Como configurar o OAuth 2.0 no MCP Server Trigger.

Booleano

false

OAuth2 Authorization Server

URL do servidor de autorização OAuth 2.0 usado para validar os tokens recebidos (por exemplo, https://your-auth-server.example.com). Disponível apenas quando OAuth2 JWT está habilitado.

String

N/A

Validate OAuth2 Audience

Se habilitado, rejeita tokens cujo claim aud não corresponde à URL do recurso MCP. Disponível apenas quando OAuth2 JWT está habilitado.

Booleano

false

External JWT

Se habilitado, o MCP Server valida tokens JWT de provedores de identidade externos (ex: Auth0, Azure AD, Okta) recebidos através do header externalJWT.

Booleano

false

Public Key

A chave pública do provedor externo. Ela é usada para validar a assinatura do token.

String

N/A

JSW Algorithm (JWA)

Especifica o algoritmo de criptografia usado para validar a assinatura digital do token JWT.

String

ES256

Documentation

Campo opcional para descrever a configuração do trigger e quaisquer regras de negócio relevantes.

String

N/A

Representação visual das ferramentas

Após salvar a configuração do trigger, uma representação visual das ferramentas é exibida no pipeline.

As ferramentas só podem ser editadas por meio do formulário de configuração do trigger. Quaisquer alterações feitas são refletidas imediatamente no pipeline após salvar.

Cada ferramenta está conectada a um conector Block Execution. Esse conector é projetado para separar logicamente a integração em subfluxos diferentes, facilitando o gerenciamento do pipeline. Para concluir a configuração, você deve criar os fluxos para cada rota dentro dos subfluxos OnProcess e OnException.

Independentemente da quantidade de ferramentas configuradas, sempre haverá uma rota padrão para casos em que uma ferramenta não seja encontrada. Você pode configurar essa rota para tratar adequadamente as ferramentas ausentes.

Modelos de payload para o MCP Server Trigger

O MCP Server Trigger inclui opções de teste nativas em que um payload é automaticamente adicionado ao Painel de Execução, facilitando o teste das suas ferramentas. Você pode listar todas as ferramentas disponíveis de uma vez ou executá-las individualmente.

As ferramentas só podem ser testadas após o trigger ser salvo. Se você adicionar, renomear ou remover uma ferramenta, salve o trigger antes de listar todas as ferramentas disponíveis ou executar uma ferramenta individualmente.

Listar todas as ferramentas disponíveis

Clique em Testar lista de ferramentas para listar todas as ferramentas disponíveis no MCP Server Trigger. O seguinte payload será adicionado ao Painel de Execução. Clique em Executar:

"tool": "tools/list" é o identificador permanente desta operação. O campo arguments é obrigatório, mesmo quando vazio.

Executar uma ferramenta

Para testar uma ferramenta individualmente, clique no ícone de três pontos ao lado da ferramenta e selecione Testar ferramenta no painel de configuração do trigger. O seguinte payload será adicionado ao Painel de Execução, já preenchido com os parâmetros de entrada da ferramenta:

Campos do payload

Campo
Tipo
Obrigatório
Descrição

tool

string

Sim

Nome da ferramenta a ser executada.

arguments

object

Sim

Payload de entrada da ferramenta. Deve seguir o schema definido para a ferramenta específica.

headers

object

Não

Headers adicionais para a execução, como autenticação customizada.

userAgent

string

Não

Identificador do agente chamador, útil para rastreabilidade e observabilidade.

Exemplo prático

Por exemplo, se você tiver uma ferramenta chamada search_web com um parâmetro query, o template gerado será:

Atualizado

Isto foi útil?