Skip to content
API referenceSync a connector's capabilities

Sync a connector's capabilities

POST/v1/mcp-integrations/{slug}/sync

Sync a connector's capabilities.

Lists the upstream's tools, prompts, resources and resource templates (for a REST connector: reads the spec or the declared endpoints) and reconciles them with the stored capabilities. A new capability is pinned at its current definition; after the first sync new capabilities arrive switched off, and every tool of an OPENAPI or HTTP connector arrives off (and privileged unless it is GET or HEAD). A changed definition is reported as drift and refused on calls until pinned again. Every new definition is scanned for tool poisoning, and a definition with findings is quarantined until an admin releases it. A capability no longer listed is marked REMOVED. A failed sync is a 200 with sync_status: FAILED; the capabilities from the last good sync are kept.

Requires an organization admin key, or a workspace admin key for the owning workspace (an organization-level connector needs an organization admin). Returns 409 when the connector is disabled. Returns 402 when the organization's plan does not include the MCP Gateway. Returns 404 when the connector 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 connector's slug (mcpi-...).

Query parameters

  • organizationstringrequired

    The organization's identifier (slug).

Responses

200application/json
  • sync_statusenum<string>

    OK or FAILED.

    One of "NEVER", "OK", "FAILED", "STALE"

  • protocol_eraenum<string>

    MODERN or LEGACY. Absent on failure.

    One of "MODERN", "LEGACY"

  • protocol_versionstring

    The MCP protocol version the upstream spoke. Absent on failure.

  • server_namestring

    The name the upstream reported (a REST connector: the spec's title). Absent on failure.

  • server_versionstring

    The version the upstream reported. Absent on failure.

  • addedinteger<int32>

    Capabilities found for the first time.

  • updatedinteger<int32>

    Known capabilities whose details changed.

  • removedinteger<int32>

    Capabilities no longer listed (now REMOVED).

  • unchangedinteger<int32>

    Capabilities that did not change.

  • driftedinteger<int32>

    Capabilities whose definition now differs from the pinned one.

  • quarantinedinteger<int32>

    Active capabilities whose current definition is quarantined by the tool-poisoning scan.

  • truncatedboolean

    true when the upstream listed more capabilities (or operations) than the gateway keeps; the rest were ignored.

  • skippedobject[]

    OPENAPI: operations that did not become tools, and why.

    Child attributes
    • methodstring

      The HTTP method of the operation.

    • pathstring

      The operation's path in the document.

    • operation_idstring

      The operation's operationId, when it has one.

    • reasonstring

      Why it was skipped, for example an unsupported request body type.

  • synced_atstring<date-time>

    When the sync ran (ISO 8601).

  • 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 or SPEC_INVALID.

  • errorstring

    On failure, what went wrong.

NVIDIA Inception Program member

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