VocalDocscontracts 1.65.0

Accept an MCP tool's new definition

POST /v1/mcp-servers/{mcp_server_id}/tools/{tool_name}/accept

PropertyValue
Operationaccept_mcp_tool_pin
GroupMCP servers
Scopemcp:write
Route classcontrol
IdempotencyIdempotency-Key accepted: a retry with the same key replays the first answer
AuditAudited mcp.tool.accept (mutation)
Released in1.60.0
Phase 0 hostServed (the hosted api pins 1.65.0)

Pins the latest listed definition of an allowed tool at the revision If-Match names and answers the registration (1.60.0; mcp-client.md section 3). Agent versions keep the pin they froze: after a contract change the tool stays refused with schema_drift until a new Agent version is published with the accepted pin. A tool the latest listing lacks is not_found, from 1.61.0 with one detail mcp_tool_not_listed at /tool_name that tells it from an unknown registration (a 422 would change the status 1.60.0 answers, ADR 0029 rule 3); one that is not allowed is validation_failed with mcp_tool_not_allowed. Writes an Audit event naming the tool and both digests.

Request

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

curl -X POST "$VOCAL_API/v1/mcp-servers/mcps_.../tools/<tool_name>/accept" \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H 'If-Match: "1"' \
  -H "Idempotency-Key: $(uuidgen)"

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.
tool_namepathUpstreamToolNameyesA tool's name as its Connector or MCP server lists it (1.60.0): 1 to 128 letters, digits, _, . and -, the characters an MCP tool name may hold.
if-matchheaderstringyesThe revision the change was made against, quoted as the ETag returns it, or * to overwrite.
idempotency-keyheaderstringnoA client-chosen key, kept 24 hours per Organization, environment and route. A replay returns the stored response.

Responses

StatusContent typeShapeError codes
200application/jsonMcpServer
400application/jsonErrorEnvelopeinvalid_request
401application/jsonErrorEnvelopeunauthenticated
403application/jsonErrorEnvelopeforbidden, org_suspended
404application/jsonErrorEnvelopenot_found
409application/jsonErrorEnvelopeidempotency_in_progress, idempotency_key_reused
412application/jsonErrorEnveloperevision_mismatch
422application/jsonErrorEnvelopevalidation_failed
428application/jsonErrorEnvelopeprecondition_required
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