mcp-server

Get

Checks the details of a specific server connection instance using its unique ID and API key, returning server details like authentication status and associated server/platform info.

get/mcp-server/instance/{instanceId}

Request

  • Base URL
    https://api.mcp-handle.dev
  • URL
    https://api.mcp-handle.dev/mcp-server/instance/{instanceId}
  • Auth
    HTTP bearer

Path parameters

instanceIdstring uuid required

The ID of the connection integration instance whose status is being checked. This is returned by the Create API.

Response

Successful Response

instanceIdstring nullable

The unique identifier of the connection integration instance.

authNeededboolean

Indicates whether authentication is required for this server instance.

isAuthenticatedboolean

Indicates whether the instance is authenticated successfully.

serverNamestring

The name of the MCP server associated with the instance.

platformstring

The platform associated with the instance.

externalUserIdstring

The user's identifier on the external platform.

oauthUrlstring nullable

The OAuth URL for authentication if available, supports white label if configured.

Changes

No recorded changes to this operation across all 1 revision of this API.