ListApiMcpServerSystemTools

更新时间:
复制 MD 格式

Queries the system tools supported by the 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

openapiexplorer:ListApiMcpServerSystemTools

list

*All Resource

*

None None

Request syntax

GET /mcpSystemTools HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

maxResults

integer

No

The maximum number of entries per page for a paged query. Maximum value: 100. Default value: 20.

20

skip

integer

No

The number of data entries to skip.

5

nextToken

string

No

The token for the next query. Set this parameter to the NextToken value returned by the previous API call.

Note

You do not need to specify this parameter for the first query. If a query does not return all results, pass the NextToken value returned from the previous query to continue retrieving results.

AAAAAZjtYxxxxxxxx

Response elements

Element

Type

Description

Example

object

The request result.

requestId

string

The request ID.

9BFC4AC1-6BE4-5405-BDEC-CA288D404812

nextToken

string

The returned NextToken, which is used to retrieve more results.

Note

If this value is not returned, no more results are available.

AAAAAZjtYxxxxxxxx

maxResults

integer

The maximum number of entries per page for a paged query. Maximum value: 100. Default value: 20.

20

totalCount

integer

The total number of data records.

22

systemTools

array<object>

The list of system tools.

object

The system tool.

name

string

The name of the system tool.

mcp-system

description

string

The description of the system tool.

system tool description

Examples

Success response

JSON format

{
  "requestId": "9BFC4AC1-6BE4-5405-BDEC-CA288D404812",
  "nextToken": "AAAAAZjtYxxxxxxxx",
  "maxResults": 20,
  "totalCount": 22,
  "systemTools": [
    {
      "name": "mcp-system",
      "description": "system tool description"
    }
  ]
}

Error codes

HTTP status code

Error code

Error message

Description

400 InvalidParam.NextToken The specified NextToken is not valid. The specified nextToken is invalid.
500 InternalServerError The request has failed due to a temporary failure of the server.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.