Queries the list of MCP services.
Operation description
Queries the list of MCP services.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
starops:ListMcpServices |
list |
*DigitalEmployee
|
None | None |
Request syntax
GET /digitalEmployee/{name}/mcpServices HTTP/1.1
Path Parameters
|
Parameter |
Type |
Required |
Description |
Example |
| name |
string |
Yes |
The name of the digital employee. |
test-agent |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| maxResults |
integer |
No |
The maximum number of entries to return in this query. |
20 |
| nextToken |
string |
No |
The pagination token for the next query. |
eyJvZmZzZXQiOjIwfQ== |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response parameters. |
||
| requestId |
string |
The request ID. |
0B9377D9-C56B-5C2E-A8A4-************ |
| total |
integer |
The total number of MCP services that match the query conditions. |
10 |
| maxResults |
integer |
The maximum number of entries to return in this query. |
20 |
| nextToken |
string |
The pagination token for the next query. |
eyJvZmZzZXQiOjIwfQ== |
| mcpServices |
object |
The paginated results of MCP services. |
|
| mcpServiceList |
array<object> |
The list of MCP services. |
|
|
array<object> |
The information about a single MCP service. |
||
| displayName |
string |
The display name of the MCP service. |
Log Query |
| description |
string |
The description of the MCP service. |
Call the log query tool through 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:
Valid values:
|
public |
| vpcId |
string |
The VPC ID. |
vpc-xxx |
| vswId |
string |
The vSwitch ID. |
vsw-xxx |
| accessIp |
string |
The IP address used to access the MCP service over the VPC network. |
10.0.0.12 |
| accessPort |
integer |
The port used to access the MCP service over 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 where the VPC network is located. |
cn-hangzhou |
| connection |
object |
The connection configuration of the MCP service. |
|
| platform |
string |
The platform type of the MCP service. Valid values:
Valid values:
|
Custom |
| transport |
string |
The transport protocol of the MCP service. Valid values:
Valid values:
|
http |
| endpoint |
string |
The access endpoint of the MCP service. |
https://example.com/mcp |
| timeout |
integer |
The timeout period for requests to the MCP service, in milliseconds. |
5000 |
| auth |
object |
The authentication configuration of the MCP service. |
|
| type |
string |
The authentication type. Currently, only bearer is supported. Valid values:
Valid values:
|
bearer |
| keyInfo |
object |
The key-value information required for authentication. |
{"token":"example-token"} |
|
string |
The authentication key-value information. |
example-token |
|
| headers |
object |
The custom HTTP request headers appended when calling the MCP service. |
{"X-Custom-Header":"example-value"} |
|
string |
The value of the custom HTTP request header. |
{"test":"test"} |
|
| 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. |
Query Logs |
| displayName |
string |
The display name of the MCP tool. |
Log Query Tool |
| description |
string |
The description of the MCP tool. |
Query logs in a specified Logstore |
| inputSchema |
object |
The JSON Schema of the MCP tool input parameters. |
{"type":"object","properties":{"query":{"type":"string"}},"required":["query"]} |
|
any |
The extension field of the MCP tool input schema. |
{"type":"string"} |
|
| outputSchema |
object |
The JSON Schema of the MCP tool output results. |
{"type":"object"} |
|
any |
The extension field of the MCP tool output schema. |
{"type":"string"} |
|
| icons |
array<object> |
The list of MCP tool icons. |
[] |
|
object |
The configuration of a single MCP tool. |
[] |
|
|
any |
The extension field of the tool icon. |
https://example.com/icon.png |
|
| execution |
object |
The execution configuration of the MCP tool. |
{} |
|
any |
The extension field of the tool execution configuration. |
{} |
|
| annotations |
object |
The annotation information of the MCP tool. |
{} |
|
any |
The extension field of the tool annotations. |
{} |
|
| enable |
boolean |
Indicates whether the MCP tool is enabled. |
true |
| confirm |
boolean |
Specifies 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-************",
"total": 10,
"maxResults": 20,
"nextToken": "eyJvZmZzZXQiOjIwfQ==",
"mcpServices": {
"mcpServiceList": [
{
"displayName": "Log Query",
"description": "Call the log query tool through 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": "{\"test\":\"test\"}"
}
},
"tools": [
{
"name": "query_logs",
"title": "Query Logs",
"displayName": "Log Query Tool",
"description": "Queries logs in a specified Logstore",
"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.