GetMcpService - - Alibaba Cloud Documentation Center

Queries an MCP service.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

starops:GetMcpService

get

*DigitalEmployee

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

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
name	string	Yes	The name of the digital employee.	test-agent
mcpServiceName	string	Yes	The service name of the MCP service.	log-query

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	The response data.
requestId	string	The request ID.	0B9377D9-C56B-5C2E-A8A4-************
regionId	string	The region of the current request.	cn-hangzhou
mcpService	object	The MCP service details.
displayName	string	The display name of the MCP service.	日志查询
description	string	The description of the MCP service.	通过 MCP 调用日志查询工具。
enable	boolean	Indicates whether the MCP service is enabled.	true
network	object	The network connectivity information.
mode	string	The network access mode of the MCP service. Valid values: public and vpc.	public
vpcId	string	The VPC ID.	vpc-xxx
vswId	string	The vSwitch ID.	vsw-xxx
accessIp	string	The IP address for accessing the MCP service in the VPC network.	10.0.0.12
accessPort	integer	The port for accessing the MCP service in the VPC network. Valid values: 1 to 65535.	8080
securityGroupId	string	The security group ID.	sg-xxx
gatewayId	string	The gateway ID.	gw-xxx
mcpServerId	string	The MCP Server instance ID.	mcp-xxx
region	string	The region of the VPC network.	cn-hangzhou
connection	object	The MCP service connection configuration.
platform	string	The platform type of the MCP service. Valid values: AIGateway and Custom.	Custom
transport	string	The transport protocol of the MCP service. Valid values: http and sse.	http
endpoint	string	The access endpoint of the MCP service.	https://example.com/mcp
timeout	integer	The timeout for requests to the MCP service. Unit: milliseconds.	5000
auth	object	The authentication configuration of the MCP service.
type	string	The authentication type. Currently, only bearer is supported.	bearer
keyInfo	object	The key-value information required for authentication.	{"token":"example-token"}
	string	The authentication key-value information.	example-token
tools	array<object>	The list of MCP tools.	[{"name":"query_logs"}]
	array<object>	The configuration of a single MCP tool.	[{"name":"query_logs"}]
name	string	The name of the MCP tool.	query_logs
title	string	The title of the MCP tool.	查询日志
displayName	string	The display name of the MCP tool.	日志查询工具
description	string	The description of the MCP tool.	查询指定日志库中的日志。
inputSchema	object	The JSON Schema for input parameters of the MCP tool.	{"type":"object","properties":{"query":{"type":"string"}},"required":["query"]}
	any	The extension fields of the MCP tool input schema.	{"type":"string"}
outputSchema	object	The JSON Schema for the output of the MCP tool.	{"type":"object"}
	any	The extension fields of the MCP tool output schema.	{"type":"string"}
icons	array<object>	The list of MCP tool icons.	[]
	object	The icon configuration of a single MCP tool.	[]
	any	The extension fields of the tool icon.	https://example.com/icon.png
execution	object	The execution configuration of the MCP tool.	{}
	any	The extension fields of the tool execution configuration.	{}
annotations	object	The annotation information of the MCP tool.	{}
	any	The extension fields of the tool annotations.	{}
enable	boolean	Indicates whether the MCP tool is enabled.	true
confirm	boolean	Indicates whether user confirmation is required before calling the MCP tool.	false
mcpServiceName	string	The service name of the MCP service.	log-query

Examples

Success response

JSON format

{
  "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"
        }
      }
    },
    "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"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.