Lists the system tools supported by the MCP service.
Try it now
Test
RAM authorization
|
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 to return on each page. The maximum value is 100. The default value is 20. |
20 |
| skip |
integer |
No |
The number of entries to skip. |
5 |
| nextToken |
string |
No |
The token to start the next query. Set this parameter to the NextToken value returned by the last API call. Note
Do not specify this parameter for the first query. If a query does not return all results, pass the NextToken value from the previous response to the next query to continue. |
AAAAAZjtYxxxxxxxx |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The request result. |
||
| requestId |
string |
The request ID. |
9BFC4AC1-6BE4-5405-BDEC-CA288D404812 |
| nextToken |
string |
The NextToken value. Use this value to retrieve more results. Note
If this parameter is not returned, no more results are available. |
AAAAAZjtYxxxxxxxx |
| maxResults |
integer |
The maximum number of entries to return on each page. The maximum value is 100. The default value is 20. |
20 |
| totalCount |
integer |
The total number of records. |
22 |
| systemTools |
array<object> |
The list of system tools. |
|
|
object |
A 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 for a complete list.
Release notes
See Release Notes for a complete list.