mcp

POST `/v1/mcp/connections`

Create an MCP connection (Connect AI tool).

प्रमाणीकरण

एपिआई कुञ्जीलाई बियरर टोकन (bearer token) को रूपमा पठाउनुहोस्। कुञ्जीसँग mcp.manage अनुमति हुनुपर्छ; अनुमति नभएको कुञ्जीलाई 404 होइन, 403 मार्फत अस्वीकार गरिन्छ।

तपाईंको संस्थाको आइडी राख्ने ठाउँ

यो इन्डपोटले JSON बडीमा एक फिल्डको रूपमा org_id लिन्छ।

तपाईंको संस्थाको आइडी (ID) तपाईंको ड्यासबोर्डमा रहेको API कुञ्जीहरू (keys) स्क्रिनमा, कुञ्जीको छेउमा हुन्छ। तपाईंले गर्ने प्रत्येक कलमा यही आइडी प्रयोग हुन्छ।

प्रयास गर्नुहोस्

कोणीय कोष्ठकभित्र भएका जुनसुकै कुरालाई आफ्नो मानहरूद्वारा बदल्नुहोस्, र मुख्य स्थानहोल्डरलाई तपाईंको ड्यासबोर्डको कुञ्जीद्वारा बदल्नुहोस्।

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 कन्सोलले तपाईंको वास्तविक संस्थाको आईडी र आफ्नै कुञ्जी भरिदिन्छ, र लाइभ 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

POST /v1/mcp/connections