Skip to content
API referenceTest an MCP server's connection

Test an MCP server's connection

POST/v1/mcp-servers/{slug}/test

Test an MCP server's connection.

Tests the server's connector, as the connector test does: a failed check is a 200 with ok: false.

Requires an organization admin key, or a workspace admin key for the server's workspace. Returns 402 when the organization's plan does not include the MCP Gateway. Returns 404 when the server does not exist in the organization.

Authorization

  • AuthorizationBearer va_

    A platform API key (va_...), created under Settings > API keys. Scoped to an organization or one workspace, with an admin or member role. Used by the management API.

Path parameters

  • slugstringrequired

    The MCP server's slug (mcps-...).

Query parameters

  • organizationstringrequired

    The organization's identifier (slug).

Responses

200application/json
  • okboolean

    Whether the gateway could connect (for a REST connector: read the spec or declarations into tools).

  • protocol_eraenum<string>

    MODERN or LEGACY.

    One of "MODERN", "LEGACY"

  • protocol_versionstring

    The MCP protocol version agreed.

  • server_namestring

    The name the upstream reported (a REST connector: the spec's title, or the connector's name).

  • server_versionstring

    The version the upstream reported.

  • capabilitiesstring[]

    The capability groups the upstream declared, for example tools, prompts, resources.

  • latency_msinteger<int64>

    How long the check took, in milliseconds.

  • error_kindstring

    On failure, the kind of error: EGRESS_BLOCKED, UNREACHABLE, TIMEOUT, AUTH_FAILED, HTTP_ERROR, PROTOCOL_ERROR, UNSUPPORTED_VERSION, UNSUPPORTED_TRANSPORT, RESPONSE_TOO_LARGE, SPEC_INVALID, CONNECTION_REQUIRED (OAUTH_AUTO: no connected account to test with) or OAUTH_ERROR.

  • errorstring

    On failure, what went wrong.

NVIDIA Inception Program member

VectorAxis is built by GK Labs, a member of NVIDIA Inception.