All Products
Search
Document Center

DataWorks:ListMcpServers

Last Updated:Jun 07, 2026

Retrieves a paginated list of MCP servers.

Operation description

Request

This operation retrieves a paginated list of all MCP Servers within your account. You can filter the list by search keyword and visibility level, and control pagination by specifying the maximum number of results and a next page token.

  • Q: Optional. The search keyword for a fuzzy search on MCP Server names.

  • Visibility: Optional. The visibility level for filtering the results.

  • MaxResults: Optional. The maximum number of results to return per page. By default, no limit is applied.

  • NextToken: Optional. The next page token from a previous response. Use this parameter to retrieve the next page of results.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

Q

string

No

The search keyword for a fuzzy search on MCP Server names.

mcp

Visibility

array

No

The visibility level for filtering the results.

-

string

No

The visibility level. Valid values: TENANT (visible within the account), PROJECT (visible to specified projects), and USER (visible to specified users).

TENANT

MaxResults

integer

No

The maximum number of results to return per page.

20

NextToken

string

No

The next page token from a previous response. Use this token to retrieve the next page of results. Leave this parameter empty for the first request.

12345

Response elements

Element

Type

Description

Example

object

The response object.

RequestId

string

The request ID.

824F80BA-1778-5D8A-BAFF-668A4D9C4CC7

PagingInfo

object

The paging information.

TotalCount

integer

The total count of entries that match the filter criteria.

100

McpServers

array<object>

A list of MCP Server objects.

array<object>

CreatorId

string

The creator ID.

805298765622151

ModifierId

string

The ID of the user who last modified the server.

123456

Name

string

The name of the MCP Server.

my-mcp-server

Config

object

The connection configuration of 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.

TENANT

GmtCreateTime

string

The creation time, as a millisecond timestamp.

1780555634000

GmtModifiedTime

string

The last modified time, as a millisecond timestamp.

1780555634000

MaxResults

integer

The maximum number of results returned on the current page.

100

NextToken

string

The token for the next page of results. A null value indicates that all results have been returned.

2

Examples

Success response

JSON format

{
  "RequestId": "824F80BA-1778-5D8A-BAFF-668A4D9C4CC7",
  "PagingInfo": {
    "TotalCount": 100,
    "McpServers": [
      {
        "CreatorId": "805298765622151",
        "ModifierId": "123456",
        "Name": "my-mcp-server",
        "Config": {
          "Url": "https://example.com/mcp/sse",
          "Transport": "SSE",
          "CustomHeaders": {}
        },
        "Visibility": "TENANT",
        "GmtCreateTime": "1780555634000",
        "GmtModifiedTime": "1780555634000"
      }
    ],
    "MaxResults": 100,
    "NextToken": "2"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.