GetMcpService
Queries an MCP service
Try it now
Test
RAM authorization
Request syntax
GET /digitalEmployee/{name}/mcpService/{mcpServiceName} HTTP/1.1Path Parameters
|
Parameter |
Type |
Required |
Description |
Example |
| name |
string |
Yes |
The name of the digital employee. |
test-agent |
| mcpServiceName |
string |
Yes |
The 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 parameters. |
||
| requestId |
string |
The request ID. |
0B9377D9-C56B-5C2E-A8A4-************ |
| regionId |
string |
The region of the current request. |
cn-hangzhou |
| mcpService |
object |
The details of the MCP service. |
|
| displayName |
string |
The display name of the MCP service. |
日志查询 |
| description |
string |
The description of the MCP service. |
Use log query tools through MCP. |
| enable |
boolean |
Indicates whether the MCP service is enabled. |
true |
| network |
object |
The network connection information. |
|
| mode |
string |
public |
|
| vpcId |
string |
vpc-xxx |
|
| vswId |
string |
vsw-xxx |
|
| accessIp |
string |
10.0.0.12 |
|
| accessPort |
integer |
8080 |
|
| securityGroupId |
string |
sg-xxx |
|
| gatewayId |
string |
gw-xxx |
|
| mcpServerId |
string |
mcp-xxx |
|
| region |
string |
cn-hangzhou |
|
| connection |
object |
The connection configuration of the MCP service. |
|
| platform |
string |
Custom |
|
| transport |
string |
http |
|
| endpoint |
string |
https://example.com/mcp |
|
| timeout |
integer |
5000 |
|
| auth |
object |
||
| type |
string |
bearer |
|
| keyInfo |
object |
{"token":"example-token"} |
|
|
string |
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 |
query_logs |
|
| title |
string |
查询日志 |
|
| displayName |
string |
日志查询工具 |
|
| description |
string |
查询指定日志库中的日志。 |
|
| inputSchema |
object |
{"type":"object","properties":{"query":{"type":"string"}},"required":["query"]} |
|
|
any |
{"type":"string"} |
||
| outputSchema |
object |
{"type":"object"} |
|
|
any |
{"type":"string"} |
||
| icons |
array<object> |
[] |
|
|
object |
[] |
||
|
any |
https://example.com/icon.png |
||
| execution |
object |
{} |
|
|
any |
{} |
||
| annotations |
object |
{} |
|
|
any |
{} |
||
| enable |
boolean |
true |
|
| confirm |
boolean |
false |
|
| mcpServiceName |
string |
The 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.