MCP Tools Reference: ces.googleapis.com

Ferramenta: list_agents

Lista os agentes no app especificado.

O exemplo a seguir demonstra como usar curl para invocar a ferramenta list_agents MCP.

Solicitação curl 
                  
curl --location 'https://ces.[REGION].rep.googleapis.com/mcp' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "list_agents",
    "arguments": {
      // provide these details according to the tool's MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

Esquema de entrada

Mensagem de solicitação para AgentService.ListAgents.

ListAgentsRequest

Representação JSON 
{
  "parent": string,
  "pageSize": integer,
  "pageToken": string,
  "filter": string,
  "orderBy": string
}
Campos
parent

string

Obrigatório. O nome do recurso do app de que os agentes serão listados.
pageSize

integer

Opcional. Tamanho da página solicitada. O servidor pode retornar menos resultados do que o solicitado. Se não for especificado, o servidor escolherá um padrão apropriado.
pageToken

string

Opcional. O valor next_page_token retornado de uma chamada AgentService.ListAgents de lista anterior.
filter

string

Opcional. Filtro a ser aplicado ao listar os agentes. Consulte https://google.aip.dev/160 para mais detalhes.
orderBy

string

Opcional. Campo de classificação. Somente "name" e "create_time" são aceitos. Consulte https://google.aip.dev/132#ordering para mais detalhes.

Esquema de saída

Mensagem de resposta para AgentService.ListAgents.

ListAgentsResponse

Representação JSON 
{
  "agents": [
    {
      object (Agent)
    }
  ],
  "nextPageToken": string
}
Campos
agents[]

object (Agent)

A lista de agentes.
nextPageToken

string

Um token que pode ser enviado como ListAgentsRequest.page_token para recuperar a próxima página. A ausência desse campo indica que não há páginas subsequentes.

Agente

Representação JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "modelSettings": {
    object (ModelSettings)
  },
  "instruction": string,
  "tools": [
    string
  ],
  "childAgents": [
    string
  ],
  "beforeAgentCallbacks": [
    {
      object (Callback)
    }
  ],
  "afterAgentCallbacks": [
    {
      object (Callback)
    }
  ],
  "beforeModelCallbacks": [
    {
      object (Callback)
    }
  ],
  "afterModelCallbacks": [
    {
      object (Callback)
    }
  ],
  "beforeToolCallbacks": [
    {
      object (Callback)
    }
  ],
  "afterToolCallbacks": [
    {
      object (Callback)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "guardrails": [
    string
  ],
  "etag": string,
  "toolsets": [
    {
      object (AgentToolset)
    }
  ],
  "generatedSummary": string,
  "transferRules": [
    {
      object (TransferRule)
    }
  ],

  // Union field agent_type can be only one of the following:
  "llmAgent": {
    object (LlmAgent)
  },
  "remoteDialogflowAgent": {
    object (RemoteDialogflowAgent)
  }
  // End of list of possible types for union field agent_type.
}
Campos
name

string

Identificador. O identificador exclusivo do agente. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
displayName

string

Obrigatório. Nome de exibição do agente.
description

string

Opcional. Descrição do agente legível por humanos.
modelSettings

object (ModelSettings)

Opcional. Configurações do modelo de LLM.
instruction

string

Opcional. Instruções para o modelo de LLM orientar o comportamento do agente.
tools[]

string

Opcional. Lista de ferramentas disponíveis para o agente. Formato: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
childAgents[]

string

Opcional. Lista de agentes filhos na árvore de agentes. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
beforeAgentCallbacks[]

object (Callback)

Opcional. Os callbacks a serem executados antes da chamada do agente. Os callbacks fornecidos são executados sequencialmente na ordem exata em que aparecem na lista. Se um callback retornar uma resposta substituída, a execução será interrompida e os callbacks restantes serão ignorados.
afterAgentCallbacks[]

object (Callback)

Opcional. Os retornos de chamada a serem executados depois que o agente for chamado. Os callbacks fornecidos são executados sequencialmente na ordem exata em que aparecem na lista. Se um callback retornar uma resposta substituída, a execução será interrompida e os callbacks restantes serão ignorados.
beforeModelCallbacks[]

object (Callback)

Opcional. Os callbacks a serem executados antes de chamar o modelo. Se houver várias chamadas para o modelo, o callback será executado várias vezes. Os callbacks fornecidos são executados sequencialmente na ordem exata em que aparecem na lista. Se um callback retornar uma resposta substituída, a execução será interrompida e os callbacks restantes serão ignorados.
afterModelCallbacks[]

object (Callback)

Opcional. Os callbacks a serem executados depois que o modelo é chamado. Se houver várias chamadas para o modelo, o callback será executado várias vezes. Os callbacks fornecidos são executados sequencialmente na ordem exata em que aparecem na lista. Se um callback retornar uma resposta substituída, a execução será interrompida e os callbacks restantes serão ignorados.
beforeToolCallbacks[]

object (Callback)

Opcional. Os callbacks a serem executados antes da invocação da ferramenta. Se houver várias invocações de ferramentas, o callback será executado várias vezes. Os callbacks fornecidos são executados sequencialmente na ordem exata em que aparecem na lista. Se um callback retornar uma resposta substituída, a execução será interrompida e os callbacks restantes serão ignorados.
afterToolCallbacks[]

object (Callback)

Opcional. Os callbacks a serem executados depois que a ferramenta for invocada. Se houver várias invocações de ferramentas, o callback será executado várias vezes. Os callbacks fornecidos são executados sequencialmente na ordem exata em que aparecem na lista. Se um callback retornar uma resposta substituída, a execução será interrompida e os callbacks restantes serão ignorados.
createTime

string (Timestamp format)

Apenas saída. Carimbo de data/hora em que o agente foi criado.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Apenas saída. Carimbo de data/hora da última atualização do agente.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
guardrails[]

string

Opcional. Lista de proteções do agente. Formato: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
etag

string

Etag usada para garantir que o objeto não mudou durante uma operação de leitura-modificação-gravação. Se a ETag estiver vazia, a atualização vai substituir todas as mudanças simultâneas.
toolsets[]

object (AgentToolset)

Opcional. Lista de conjuntos de ferramentas para o agente.
generatedSummary

string

Apenas saída. Se o agente for gerado pelo assistente de LLM, esse campo vai conter um resumo descritivo da geração.
transferRules[]

object (TransferRule)

Opcional. Regras de transferência de agente. Se várias regras forem correspondentes, a primeira da lista será usada.
Campo de união agent_type. O tipo de agente. agent_type pode ser apenas de um dos tipos a seguir:
llmAgent

object (LlmAgent)

Opcional. O tipo de agente padrão.
remoteDialogflowAgent

object (RemoteDialogflowAgent)

Opcional. O agente Dialogflow remoto a ser usado para a execução do agente. Se esse campo for definido, todas as outras propriedades no nível do agente serão ignoradas.

Observação: se o agente do Dialogflow estiver em um projeto diferente do app, conceda roles/dialogflow.client ao agente de serviço do CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

RemoteDialogflowAgent

Representação JSON 
{
  "agent": string,
  "flowId": string,
  "environmentId": string,
  "inputVariableMapping": {
    string: string,
    ...
  },
  "outputVariableMapping": {
    string: string,
    ...
  },
  "respectResponseInterruptionSettings": boolean
}
Campos
agent

string

Obrigatório. O nome do recurso do agente do Dialogflow. Formato: projects/{project}/locations/{location}/agents/{agent}
flowId

string

Opcional. O ID do fluxo no agente do Dialogflow.
environmentId

string

Opcional. O ID do ambiente do agente do Dialogflow que será usado para a execução do agente. Se não for especificado, o ambiente de rascunho será usado.
inputVariableMapping

map (key: string, value: string)

Opcional. O mapeamento dos nomes das variáveis do app para os nomes dos parâmetros da sessão do Dialogflow que serão enviados ao agente do Dialogflow como entrada.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
outputVariableMapping

map (key: string, value: string)

Opcional. O mapeamento dos nomes dos parâmetros da sessão do Dialogflow para os nomes das variáveis do app que serão enviadas de volta ao agente do CES após o término da execução do agente do Dialogflow.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
respectResponseInterruptionSettings

boolean

Opcional. Indica se as configurações de interrupção no nível da mensagem configuradas no agente do Dialogflow devem ser respeitadas.

  • Se for "false", todas as mensagens de resposta do agente do Dialogflow vão seguir as configurações de interrupção no nível do app.
  • Se for verdadeiro: apenas as mensagens de resposta com allow_playback_interruption definido como "true" poderão ser interrompidas. Todas as outras mensagens seguem as configurações de interrupção no nível do app.

InputVariableMappingEntry

Representação JSON 
{
  "key": string,
  "value": string
}
Campos
key

string
value

string

OutputVariableMappingEntry

Representação JSON 
{
  "key": string,
  "value": string
}
Campos
key

string
value

string

ModelSettings

Representação JSON 
{
  "model": string,

  // Union field _temperature can be only one of the following:
  "temperature": number
  // End of list of possible types for union field _temperature.
}
Campos
model

string

Opcional. O modelo de LLM que o agente deve usar. Se não estiver definido, o agente vai herdar o modelo do agente principal.

Campo de união _temperature.

_temperature pode ser apenas de um dos tipos a seguir:
temperature

number

Opcional. Se definido, essa temperatura será usada para o modelo LLM. A temperatura controla a aleatoriedade das respostas do modelo. Temperaturas mais baixas produzem respostas mais previsíveis. Temperaturas mais altas produzem respostas mais criativas.

Callback

Representação JSON 
{
  "description": string,
  "disabled": boolean,
  "proactiveExecutionEnabled": boolean,

  // Union field callback can be only one of the following:
  "pythonCode": string
  // End of list of possible types for union field callback.
}
Campos
description

string

Opcional. Descrição legível do callback.
disabled

boolean

Opcional. Se o callback está desativado. Os retornos de chamada desativados são ignorados pelo agente.
proactiveExecutionEnabled

boolean

Opcional. Se ativado, o callback também será executado em saídas intermediárias do modelo. Essa configuração só afeta o retorno de chamada após o modelo. ATIVE COM CUIDADO. Normalmente, o callback do modelo só precisa ser executado depois de receber todas as respostas do modelo. Ativar a execução proativa pode ter implicações negativas no custo e na latência da execução. Portanto, essa opção só deve ser ativada em situações raras.
Campo de união callback. O callback a ser executado. callback pode ser apenas de um dos tipos a seguir:
pythonCode

string

Obrigatório. O código Python a ser executado para o callback.

Carimbo de data/hora

Representação JSON 
{
  "seconds": string,
  "nanos": integer
}
Campos
seconds

string (int64 format)

Representa os segundos do horário UTC desde a época Unix 1970-01-01T00:00:00Z. Precisa estar entre -62135596800 e 253402300799 (o que corresponde a 0001-01-01T00:00:00Z a 9999-12-31T23:59:59Z).
nanos

integer

Frações não negativas de um segundo com resolução de nanossegundos. Esse campo é a parte de nanossegundos da duração, não uma alternativa aos segundos. Os valores de segundos negativos com frações ainda precisam ter valores em nanossegundos não negativos que representam períodos posteriores. O valor precisa ser de 0 a 999.999.999 (inclusive).

AgentToolset

Representação JSON 
{
  "toolset": string,
  "toolIds": [
    string
  ]
}
Campos
toolset

string

Obrigatório. O nome do recurso do conjunto de ferramentas. Formato: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
toolIds[]

string

Opcional. Os IDs das ferramentas para filtrar o conjunto de ferramentas.

TransferRule

Representação JSON 
{
  "childAgent": string,
  "direction": enum (Direction),

  // Union field rule_type can be only one of the following:
  "deterministicTransfer": {
    object (DeterministicTransfer)
  },
  "disablePlannerTransfer": {
    object (DisablePlannerTransfer)
  }
  // End of list of possible types for union field rule_type.
}
Campos
childAgent

string

Obrigatório. O nome do recurso do agente filho a que a regra se aplica. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
direction

enum (Direction)

Obrigatório. A direção da transferência.
Campo de união rule_type. O tipo de regra. rule_type pode ser apenas de um dos tipos a seguir:
deterministicTransfer

object (DeterministicTransfer)

Opcional. Uma regra que transfere imediatamente para o agente de destino quando a condição é atendida.
disablePlannerTransfer

object (DisablePlannerTransfer)

Opcional. Regra que impede a transferência do planejador para o agente de destino.

DeterministicTransfer

Representação JSON 
{

  // Union field condition_type can be only one of the following:
  "expressionCondition": {
    object (ExpressionCondition)
  },
  "pythonCodeCondition": {
    object (PythonCodeCondition)
  }
  // End of list of possible types for union field condition_type.
}
Campos
Campo de união condition_type. A condição a ser avaliada. condition_type pode ser apenas de um dos tipos a seguir:
expressionCondition

object (ExpressionCondition)

Opcional. Uma regra que avalia uma condição de estado da sessão. Se a condição for avaliada como verdadeira, a transferência vai ocorrer.
pythonCodeCondition

object (PythonCodeCondition)

Opcional. Uma regra que usa um bloco de código Python para avaliar as condições. Se a condição for avaliada como verdadeira, a transferência vai ocorrer.

ExpressionCondition

Representação JSON 
{
  "expression": string
}
Campos
expression

string

Obrigatório. A representação de string da condição cloud.api.Expression.

PythonCodeCondition

Representação JSON 
{
  "pythonCode": string
}
Campos
pythonCode

string

Obrigatório. O código Python a ser executado.

DisablePlannerTransfer

Representação JSON 
{
  "expressionCondition": {
    object (ExpressionCondition)
  }
}
Campos
expressionCondition

object (ExpressionCondition)

Obrigatório. Se a condição for avaliada como verdadeira, o planejador não poderá transferir para o agente de destino.

Anotações de ferramentas

Dica destrutiva: ❌ | Dica idempotente: ✅ | Dica somente leitura: ✅ | Dica de mundo aberto: ❌