Returns the details of an MCP Server.
Operation description
Description
This API returns the detailed configuration of a specific MCP Server by name. The response includes the creator ID, modifier ID, service address, and transport protocol. You must provide the exact name of the MCP Server in the request.
Notes
-
Ensure you have the required permissions to call this API.
-
The MCP Server name is case-sensitive.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| Name |
string |
Yes |
The name of the MCP Server to retrieve. |
my-mcp-server |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response schema. |
||
| RequestId |
string |
The request ID. |
824F80BA-1778-5D8A-BAFF-668A4D9C4CC7 |
| McpServer |
object |
The MCP Server configuration. |
|
| CreatorId |
string |
The creator ID. |
123456 |
| ModifierId |
string |
The modifier ID. |
123456 |
| Name |
string |
The MCP Server name. |
my-mcp-server |
| Config |
object |
The connection configuration for the MCP Server. |
|
| Url |
string |
The service address of the MCP Server. |
https://example.com/mcp/sse |
| Transport |
string |
The transport protocol. |
SSE |
| CustomHeaders |
object |
The custom headers. |
{} |
| Visibility |
string |
The visibility level. Valid values: TENANT (visible within the account), PROJECT (visible to specified projects), and USER (visible to specified users). |
TENANT |
| GmtCreateTime |
string |
The creation time, provided as a timestamp in milliseconds. |
1780555634000 |
| GmtModifiedTime |
string |
The modification time, provided as a timestamp in milliseconds. |
1780555634000 |
Examples
Success response
JSON format
{
"RequestId": "824F80BA-1778-5D8A-BAFF-668A4D9C4CC7",
"McpServer": {
"CreatorId": "123456",
"ModifierId": "123456",
"Name": "my-mcp-server",
"Config": {
"Url": "https://example.com/mcp/sse",
"Transport": "SSE",
"CustomHeaders": {}
},
"Visibility": "TENANT",
"GmtCreateTime": "1780555634000",
"GmtModifiedTime": "1780555634000"
}
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.