GetMcpService - STAROps: Central de Documentação do Alibaba Cloud

Consulta um serviço MCP.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

starops:GetMcpService

get

*DigitalEmployee

acs:starops:{#regionId}:{#accountId}:digitalemployee/{#name}/mcpservice/{#mcpServiceName}

Nenhuma

Sintaxe da solicitação

GET /digitalEmployee/{name}/mcpService/{mcpServiceName} HTTP/1.1

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
name	string	Sim	O nome do funcionário digital.	test-agent
mcpServiceName	string	Sim	O nome do serviço MCP.	log-query

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

Nenhum parâmetro necessário.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O corpo da resposta.
requestId	string	O ID da solicitação.	0B9377D9-C56B-5C2E-A8A4-************
regionId	string	A região da solicitação atual.	cn-hangzhou
mcpService	object	Os detalhes do serviço MCP.
displayName	string	O nome de exibição do serviço MCP.	日志查询
description	string	A descrição do serviço MCP.	通过 MCP 调用日志查询工具。
enable	boolean	Indica se o serviço MCP está ativado.	true
network	object	As informações de conectividade de rede.
mode	string	O modo de acesso à rede do serviço MCP. Valores válidos: public e vpc.	public
vpcId	string	O ID da VPC.	vpc-xxx
vswId	string	O ID do vSwitch.	vsw-xxx
accessIp	string	O endereço IP usado para acessar o serviço MCP pela rede VPC.	10.0.0.12
accessPort	integer	A porta usada para acessar o serviço MCP pela rede VPC. Valores válidos: 1 a 65535.	8080
securityGroupId	string	O ID do grupo de segurança.	sg-xxx
gatewayId	string	O ID do gateway.	gw-xxx
mcpServerId	string	O ID da instância do MCP Server.	mcp-xxx
region	string	A região onde a rede VPC está localizada.	cn-hangzhou
connection	object	A configuração de conexão do serviço MCP.
platform	string	O tipo de plataforma do serviço MCP. Valores válidos: AIGateway e Custom.	Custom
transport	string	O protocolo de transporte do serviço MCP. Valores válidos: http e sse.	http
endpoint	string	O endpoint de acesso do serviço MCP.	https://example.com/mcp
timeout	integer	O período de tempo limite para solicitações ao serviço MCP. Unidade: milissegundos.	5000
auth	object	A configuração de autenticação do serviço MCP.
type	string	O tipo de autenticação. Atualmente, bearer é suportado.	bearer
keyInfo	object	As informações de chave-valor necessárias para autenticação.	{"token":"example-token"}
	string	认证键值信息。	example-token
headers	object
	string
tools	array<object>	A lista de ferramentas MCP.	[{"name":"query_logs"}]
	array<object>	A configuração de uma única ferramenta MCP.	[{"name":"query_logs"}]
name	string	O nome da ferramenta MCP.	query_logs
title	string	O título da ferramenta MCP.	查询日志
displayName	string	O nome de exibição da ferramenta MCP.	日志查询工具
description	string	A descrição da ferramenta MCP.	查询指定日志库中的日志。
inputSchema	object	O JSON Schema dos parâmetros de entrada da ferramenta MCP.	{"type":"object","properties":{"query":{"type":"string"}},"required":["query"]}
	any	MCP 工具输入 Schema 扩展字段。	{"type":"string"}
outputSchema	object	O JSON Schema dos resultados de saída da ferramenta MCP.	{"type":"object"}
	any	MCP 工具输出 Schema 扩展字段。	{"type":"string"}
icons	array<object>	A lista de ícones da ferramenta MCP.	[]
	object	A configuração de uma ferramenta MCP individual.	[]
	any	工具图标扩展字段。	https://example.com/icon.png
execution	object	A configuração de execução da ferramenta MCP.	{}
	any	工具执行配置扩展字段。	{}
annotations	object	As informações de anotação da ferramenta MCP.	{}
	any	工具注解扩展字段。	{}
enable	boolean	Indica se a ferramenta MCP está ativada.	true
confirm	boolean	Indica se a confirmação do usuário é necessária antes de chamar a ferramenta MCP.	false
mcpServiceName	string	O nome do serviço MCP.	log-query

Exemplos

Resposta de sucesso

JSON formato

{
  "requestId": "0B9377D9-C56B-5C2E-A8A4-************",
  "regionId": "cn-hangzhou",
  "mcpService": {
    "displayName": "日志查询",
    "description": "通过 MCP 调用日志查询工具。",
    "enable": true,
    "network": {
      "mode": "public",
      "vpcId": "vpc-xxx",
      "vswId": "vsw-xxx",
      "accessIp": "10.0.0.12",
      "accessPort": 8080,
      "securityGroupId": "sg-xxx",
      "gatewayId": "gw-xxx",
      "mcpServerId": "mcp-xxx",
      "region": "cn-hangzhou"
    },
    "connection": {
      "platform": "Custom",
      "transport": "http",
      "endpoint": "https://example.com/mcp",
      "timeout": 5000,
      "auth": {
        "type": "bearer",
        "keyInfo": {
          "key": "example-token"
        }
      },
      "headers": {
        "key": ""
      }
    },
    "tools": [
      {
        "name": "query_logs",
        "title": "查询日志",
        "displayName": "日志查询工具",
        "description": "查询指定日志库中的日志。",
        "inputSchema": {
          "key": "{\"type\":\"string\"}"
        },
        "outputSchema": {
          "key": "{\"type\":\"string\"}"
        },
        "icons": [
          {
            "key": "https://example.com/icon.png"
          }
        ],
        "execution": {
          "key": "{}"
        },
        "annotations": {
          "key": "{}"
        },
        "enable": true,
        "confirm": false
      }
    ],
    "mcpServiceName": "log-query"
  }
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.