Method: projects.locations.collections.dataConnector.invokeConnectorMcp

Faz uma chamada para um conector MCP.

Solicitação HTTP

POST https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/dataConnector}:invokeConnectorMcp

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
name

string

Obrigatório. Recurso DataConnector.

O conector de dados usado para fazer a chamada MCP.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON
{
  "method": string,
  "params": {
    object
  },
  "engine": string,
  "toolSpecVersion": string
}
Campos
method

string

Obrigatório. O método a ser invocado (por exemplo, "tools/list", "tools/call", "resources/read", "prompts/get" etc.).

params

object (Struct format)

Opcional. Parâmetros estruturados arbitrários para o método.

O uso de google.protobuf.Struct mantém o esquema de payload flexível, correspondendo ao campo params de formato livre do JSON-RPC.

engine

string

Opcional. O nome do recurso do mecanismo (por exemplo, "projects/{project}/locations/{location}/collections/{collection}/engines/{engine}"). Usado como o ID do mecanismo de pesquisa ao invocar ferramentas de registro de ferramentas que emitem solicitações do Discovery Search Service.

toolSpecVersion

string

Opcional. A versão da especificação da ferramenta para resolver a superfície da ferramenta do conector. Isso corresponde ao nome do arquivo de especificação da ferramenta BAP do conector (por exemplo, "v2", "v5.2"). Quando não definido, o servidor usa a especificação de ferramenta padrão (mais recente) para o conector. Aplicável a todos os métodos (por exemplo, "tools/list" e "tools/call").

Corpo da resposta

Mensagem de resposta que retorna o resultado de uma invocação do conector MCP. Ele contém um payload de resultado bem-sucedido ou detalhes do erro.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "result": value,
  "error": {
    object (McpError)
  }
  // End of mutually exclusive fields.
}
Campos
Exatamente um de result ou error precisa ser definido. A seguir, há uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
result

value (Value format)

Resultado bem-sucedido: dados estruturados arbitrários.

error

object (McpError)

Detalhes do erro quando a chamada falha.

Fim dos campos mutuamente exclusivos.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • discoveryengine.dataConnectors.executeAction

Para mais informações, consulte a documentação do IAM.

McpError

McpError representa detalhes do erro quando uma chamada MCP falha. Essa estrutura segue o formato do objeto de erro JSON-RPC 2.0.

Representação JSON
{
  "code": integer,
  "message": string,
  "data": value
}
Campos
code

integer

Código de erro numérico.

message

string

Descrição curta e legível por humanos do erro.

data

value (Value format)

Dados estruturados opcionais com contexto de erro adicional.