mcp

POST `/v1/mcp/connections`

Create an MCP connection (Connect AI tool).

Նույնականացում

Ուղարկեք API բանալին որպես bearer token: Բանալին պետք է ունենա mcp.manage թույլտվությունը. առանց դրա բանալին մերժվում է 403, և ոչ թե 404 կարգավիճակով:

Որտեղ տեղադրվում է ձեր կազմակերպության ID-ն

Այս վերջնակետը JSON մարմնում որպես դաշտ վերցնում է org_id-ը։

Ձեր կազմակերպության ID-ն գտնվում է Ձեր ղեկավարման վահանակի API բանալիների էկրանին՝ բուն բանալու կողքին: Այն նույն ID-ն է Ձեր կատարած յուրաքանչյուր հարցման մեջ:

Փորձել

Փոխարինեք անկյունային փակագծերում գտնվող ցանկացած բան ձեր սեփական արժեքներով, և բանալու տեղապահը՝ ձեր վահանակի բանալիով:

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[]> }'

Մուտք գործե՞լ եք: Ձեր վահանակի API վահանակը լրացնում է ձեր իրական կազմակերպության ID-ն և ձեր սեփական բանալին և գործարկում է հարցումը ուղիղ API-ի դեմ, որպեսզի կարողանաք տեսնել փաստացի պատասխանը: Բացեք այս վերջնակետը API վահանակում

Մանրամասներ

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.

Հարցման մարմին

Անուն	Տեսակ	Պահանջվում է	Ինչ է դա
`name`	`string`	Այո	—
`client`	`McpClient`	Ոչ	The AI client a connection is for (informational).
`scopes`	`string[]`	Այո	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`	Ոչ	—
`org_id`	`Uuid \| null`	Ոչ	The org the connection belongs to. Defaults to the caller's sole managed org.
`spend_cap_minor`	`integer \| null`	Ոչ	Optional per-window paid-action budget (integer minor units). Null = no cap.
`spend_currency`	`CurrencyCode`	Ոչ	ISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8).
`spend_window_seconds`	`integer`	Ոչ	—

Պատասխան

Անուն	Տեսակ	Պահանջվում է	Ինչ է դա
`id`	`Uuid`	Այո	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Այո	—
`client`	`McpClient`	Այո	The AI client a connection is for (informational).
`prefix`	`string`	Այո	The token's public lookup prefix (not a secret).
`scopes`	`string[]`	Այո	The RBAC permission keys this connection's token may exercise.
`sandbox`	`boolean`	Այո	—
`spend_cap_minor`	`integer \| null`	Ոչ	Optional per-window budget (integer minor units, CLAUDE.md §2.8) for AI-triggered paid actions. Null = no cap.
`spend_currency`	`CurrencyCode`	Ոչ	ISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8).
`spend_window_seconds`	`integer`	Այո	The rolling window the spend cap applies over.
`last_used_at`	`string \| null`	Ոչ	—
`revoked_at`	`string \| null`	Ոչ	—
`created_at`	`string`	Այո	—
`token`	`string`	Այո	The full `zmcp_…` token, shown exactly once.
`endpoint`	`string`	Այո	The MCP protocol endpoint URL to configure in the AI client.
`config`	`object`	Այո	A paste-ready config for the connection's `client`, embedding the endpoint and token. The shape differs per client: Claude Code gets an `http`-typed server, Cursor a `url` +…
`config_file`	`object`	Այո	Where that client reads `config` — e.g. `.mcp.json`. `null` when it has no file.
`command`	`object`	Այո	A one-line alternative for a client with a command line (Claude Code), else `null`. It embeds the token, so treat it like the token.
`note`	`object`	Այո	Set when the client cannot use a bearer token at all. `chatgpt_needs_oauth`: ChatGPT connects by OAuth sign-in only, so this token cannot reach it.

Այս վերջնակետի կողմից վերադարձվող սխալները

401 · 403 · 422 · 429