VocalDocscontracts 1.65.0

Read an MCP server registration

GET /v1/mcp-servers/{mcp_server_id}

PropertyValue
Operationget_mcp_server
GroupMCP servers
Scopemcp:read
Route classread
IdempotencyNo Idempotency-Key
AuditNot audited: A configuration read; a registration is not Call content and holds no credential.
Released in1.60.0
Phase 0 hostServed (the hosted api pins 1.65.0)

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the mcp:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl "$VOCAL_API/v1/mcp-servers/mcps_..." \
  -H "Authorization: Bearer $VOCAL_API_KEY"

Parameters

NameInTypeRequiredDescription
mcp_server_idpathMcpServerIdyesThe id of an MCP server registration: mcps_ and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.

Responses

StatusContent typeShapeError codes
200application/jsonMcpServer
400application/jsonErrorEnvelopeinvalid_request
401application/jsonErrorEnvelopeunauthenticated
403application/jsonErrorEnvelopeforbidden
404application/jsonErrorEnvelopenot_found
429application/jsonErrorEnveloperate_limited
500application/jsonErrorEnvelopeinternal_error

Fields of the 200 answer

The shape is McpServer.

FieldTypeRequiredDescription
allowed_toolsarray of UpstreamToolNameyesThe tools a Member with mcp:write approved; a tool not listed is never offered to any Agent.
authMcpServerAuthyes
authorization_serverstring or nullyesThe issuer the client discovered for oauth (RFC 9728, RFC 8414); null before discovery or for other auth.
connection_idConnectionIdyesThe Connection the registration created for its credential.
created_atTimestampyes
default_timeout_msintegeryes
drift_countintegernoHow many pinned tools the latest listing found changed or removed (1.61.0): above 0 exactly while status is drift_pending; absent from an api before 1.61.0.
endpointMcpEndpointyes
idMcpServerIdyes
last_listed_atTimestamp or nullyes
nameMcpServerNameyes
object"mcp_server"yes
organization_idOrganizationIdyes
pinsarray of McpToolPinyes
protocol_versionstring or nullyesThe negotiated MCP revision; null before the first listing.
revisionintegeryes
statusMcpServerStatusyes
updated_atTimestampyes