mcp

POST `/v1/mcp/connections`

Create an MCP connection (Connect AI tool).

Uthibitishaji

Tuma ufunguo wa API kama tokeni ya kubeba. Ufunguo lazima uwe na ruhusa ya mcp.manage; ufunguo usio nayo unakataliwa kwa 403, si 404.

Mahali ambapo kitambulisho cha shirika lako huwekwa

Sehemu hii ya mwisho inachukua org_id kama uwanja katika mwili wa JSON.

Kitambulisho cha shirika lako kipo kwenye skrini ya funguo za API katika dashibodi yako, kando ya ufunguo wenyewe. Ni kitambulisho kile kile katika kila ombi unalofanya.

Jaribu

Badilisha chochote kilicho ndani ya mabano ya pembe na maadili yako mwenyewe, na kishikiliaji cha ufunguo na ufunguo kutoka kwa dashibodi yako.

curl -X POST https://api.zinndigital.com/v1/mcp/connections \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "name": <string>, "scopes": <string[]> }'

Umeingia kwenye akaunti? Dashibodi yako ya kiweko cha API inajaza kitambulisho chako halisi cha shirika na ufunguo wako mwenyewe, na kuendesha ombi dhidi ya API ya moja kwa moja ili uweze kuona jibu halisi. Fungua sehemu hii ya mwisho (endpoint) kwenye konsole ya API

Maelezo

Mints a per-tool MCP connection and returns the full `zmcp_…` token **once** (only its hash is stored) plus a paste-ready client config snippet. The requested `scopes` must be permissions the caller already holds in the target org — an unheld scope is a `403` (a connection can never out-scope its creator), an unknown one a `422`. An optional spend cap bounds AI-triggered paid actions. Requires `mcp.manage`.

Mwili wa ombi

Jina	Aina	Inayohitajika	Kilicho hiki
`name`	`string`	Ndiyo	—
`client`	`McpClient`	Hapana	The AI client a connection is for (informational).
`scopes`	`string[]`	Ndiyo	RBAC permission keys to grant the token. Each must be a permission the caller holds in the target org (a connection can never out-scope its creator); an unheld scope is a `403`,…
`sandbox`	`boolean`	Hapana	—
`org_id`	`Uuid \| null`	Hapana	The org the connection belongs to. Defaults to the caller's sole managed org.
`spend_cap_minor`	`integer \| null`	Hapana	Optional per-window paid-action budget (integer minor units). Null = no cap.
`spend_currency`	`CurrencyCode`	Hapana	ISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8).
`spend_window_seconds`	`integer`	Hapana	—

Majibu

Jina	Aina	Inayohitajika	Kilicho hiki
`id`	`Uuid`	Ndiyo	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Ndiyo	—
`client`	`McpClient`	Ndiyo	The AI client a connection is for (informational).
`prefix`	`string`	Ndiyo	The token's public lookup prefix (not a secret).
`scopes`	`string[]`	Ndiyo	The RBAC permission keys this connection's token may exercise.
`sandbox`	`boolean`	Ndiyo	—
`spend_cap_minor`	`integer \| null`	Hapana	Optional per-window budget (integer minor units, CLAUDE.md §2.8) for AI-triggered paid actions. Null = no cap.
`spend_currency`	`CurrencyCode`	Hapana	ISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8).
`spend_window_seconds`	`integer`	Ndiyo	The rolling window the spend cap applies over.
`last_used_at`	`string \| null`	Hapana	—
`revoked_at`	`string \| null`	Hapana	—
`created_at`	`string`	Ndiyo	—
`token`	`string`	Ndiyo	The full `zmcp_…` token, shown exactly once.
`endpoint`	`string`	Ndiyo	The MCP protocol endpoint URL to configure in the AI client.
`config`	`object`	Ndiyo	A paste-ready MCP client config snippet embedding the endpoint + token.

Hitilafu ambazo mwisho huu unaweza kurudisha

401 · 403 · 422 · 429