Skip to main content
GET
/
v1
/
ui
/
mcp-servers
List MCP servers
curl --request GET \
  --url https://api.example.com/v1/ui/mcp-servers
[
  {
    "name": "my-mcp-server",
    "subdomain": "my-mcp-server",
    "url": "https://origin.example.com/mcp",
    "providerId": "507f1f77bcf86cd799439011",
    "id": "507f1f77bcf86cd799439011",
    "reference": "mcp_abc123",
    "mcpProxyUrl": "https://mytelescope.mcp.solvapay.com/mcp",
    "avatarUrl": "https://example.com/avatar.png",
    "tools": [
      {
        "name": "search_documents",
        "planIds": [
          "pln_abc123"
        ],
        "noPlan": false,
        "description": "Search indexed documents",
        "isVirtual": false
      }
    ],
    "defaultPlanId": "pln_default",
    "productId": "507f1f77bcf86cd799439011",
    "status": "active",
    "authHeaderName": "X-API-Key",
    "hasAuthApiKey": true,
    "totalTransactions": 42,
    "balance": 1500
  }
]

Response

200 - application/json

List of MCP servers retrieved successfully

​
name
string
required

Domain slug used to derive the MCP endpoint subdomain

Example:

"my-mcp-server"

​
subdomain
string
required

URL-safe subdomain derived from name

Example:

"my-mcp-server"

​
url
string
required

Origin URL of the actual MCP server

Example:

"https://origin.example.com/mcp"

​
providerId
string
required

Provider ID that owns this server

Example:

"507f1f77bcf86cd799439011"

​
id
string

Server ID

Example:

"507f1f77bcf86cd799439011"

​
reference
string

Unique server reference

Example:

"mcp_abc123"

​
mcpProxyUrl
string

SolvaPay proxy URL that MCP clients connect to

Example:

"https://mytelescope.mcp.solvapay.com/mcp"

​
avatarUrl
string

Avatar image URL

Example:

"https://example.com/avatar.png"

​
tools
object[]

Registered tools for this server

​
defaultPlanId
string

Default plan ID for tool access gating. Must belong to the linked product and be a free-tier plan (requiresPayment=false or price=0).

Example:

"pln_default"

​
productId
string

Associated product ID

Example:

"507f1f77bcf86cd799439011"

​
status
enum<string>

Server status

Available options:
active,
inactive,
suspended
Example:

"active"

​
authHeaderName
string

Custom auth header name for origin requests

Example:

"X-API-Key"

​
hasAuthApiKey
boolean

Whether an auth API key is configured

Example:

true

​
totalTransactions
number

Total number of tool-call transactions

Example:

42

​
balance
number

Current balance in cents

Example:

1500