Get a connector

GET/v1/mcp-integrations/{slug}

Get a connector.

Requires read access to the connector: for a workspace-owned connector, an organization admin key or a key of that workspace; for an organization-level connector, any organization member. 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

idstring<uuid>
The connector's ID (UUID).
slugstring
The connector's slug (mcpi- followed by 16 characters), used in the API paths.
organizationstring
The organization that owns it.
workspace_idstring<uuid>
The owning workspace (UUID). Absent for an organization-level connector.
namestring
Display name.
descriptionstring
Description.
urlstring
The upstream URL (the base URL for a REST connector).
kindenum<string>
MCP, OPENAPI or HTTP.
One of "MCP", "OPENAPI", "HTTP"
spec_urlstring
OPENAPI: where the document is fetched from.
has_spec_documentboolean
OPENAPI and HTTP: whether an uploaded document is stored. The document itself is not returned.
spec_formatenum<string>
OPENAPI: the format of the uploaded document, JSON or YAML.
One of "JSON", "YAML"
spec_hashstring
OPENAPI and HTTP: SHA-256 of the spec the last sync read.
http_toolsobject[]
HTTP: the declared endpoints.
Child attributes
- namestringrequired
  The tool's name, up to 128 characters.
  At least 0 characters · At most 128 characters
- methodstringrequired
  The HTTP method: GET, POST, PUT, PATCH, DELETE or HEAD.
  At least 1 characters
- pathstringrequired
  The path, relative to the connector's base URL, up to 2048 characters. May hold {name} placeholders filled from arguments.
  At least 0 characters · At most 2048 characters
- titlestring
  Human-readable title, up to 255 characters.
  At least 0 characters · At most 255 characters
- descriptionstring
  What the tool does, up to 4000 characters. Agents read it to choose the tool.
  At least 0 characters · At most 4000 characters
- querystring[]
  Arguments sent as query parameters.
- headersstring[]
  Arguments sent as request headers.
- input_schemamap<string, object>
  A JSON Schema of type object; its properties are the tool's arguments.
- body_formatstring
  How the body is encoded: json (default) or form.
query_param_namesstring[]
Names of the query-parameter credentials. Their values are never returned.
transportenum<string>
The upstream transport: HTTP.
One of "HTTP"
auth_typeenum<string>
NONE, HEADERS, OAUTH_AUTO or OAUTH_CLIENT_CREDENTIALS.
One of "NONE", "HEADERS", "OAUTH_AUTO", "OAUTH_CLIENT_CREDENTIALS"
header_namesstring[]
Names of the stored credential headers. Their values are never returned.
oauthobject
A connector's OAuth client registration with its upstream. The client secret is never returned.
Child attributes
- client_idstring
  The OAuth client ID the gateway uses at the upstream.
- registrationstring
  How the client was registered: PRE_REGISTERED (given by you), CIMD (a client ID metadata document) or DCR (dynamic client registration). Absent until the first sign-in or token request.
- has_client_secretboolean
  true when a client secret is stored.
- issuerstring
  The upstream authorization server the registration is bound to.
- scopesstring
  The scopes requested, space-separated.
- authorization_endpointstring
  Where people sign in. Shown for OPENAPI and HTTP connectors only.
- token_endpointstring
  The upstream token endpoint.
global_workspace_accessboolean
Whether every workspace in the organization may use it.
org_connection_for_usersboolean
OAUTH_AUTO: whether a signed-in person without their own connected account may use the organization connection.
statusenum<string>
ACTIVE or DISABLED.
One of "ACTIVE", "DISABLED"
protocol_versionstring
The MCP protocol version the upstream spoke on the last sync.
protocol_eraenum<string>
MODERN or LEGACY, from protocol_version.
One of "MODERN", "LEGACY"
server_namestring
The name the upstream reported on the last sync (a REST connector: the spec's title).
server_versionstring
The version the upstream reported on the last sync.
instructionsstring
Usage instructions the upstream sent for agents, if any.
sync_statusenum<string>
NEVER, OK, FAILED or STALE.
One of "NEVER", "OK", "FAILED", "STALE"
sync_errorstring
Why the last sync failed. Absent unless sync_status is FAILED.
last_synced_atstring<date-time>
When the last successful sync finished (ISO 8601).
last_sync_attempt_atstring<date-time>
When a sync was last attempted (ISO 8601).
created_bystring
The user who created it.
created_atstring<date-time>
When it was created (ISO 8601).
updated_atstring<date-time>
When it was last changed (ISO 8601).
guardrail_slugsstring[]
Guardrails run on every call through this connector, in order. Empty when there are none.

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