user_invite
Send email invitations to new users and optionally grant product access. Manage user onboarding through the MCP Pickaxe Server.
Instructions
Send email invitations to new users with optional product access.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| studio | No | Studio name to use. Available: STAGING, MAIN, DEV, PRODUCTION. Default: PRODUCTION | |
| emails | Yes | Array of email addresses to invite | |
| productIds | No | Array of product IDs to grant access to |
Implementation Reference
- src/index.ts:376-396 (registration)Tool registration for 'user_invite', including name, description, and input schema definition.{ name: "user_invite", description: "Send email invitations to new users with optional product access.", inputSchema: { type: "object", properties: { studio: studioParam, emails: { type: "array", items: { type: "string" }, description: "Array of email addresses to invite", }, productIds: { type: "array", items: { type: "string" }, description: "Array of product IDs to grant access to", }, }, required: ["emails"], }, },
- src/index.ts:379-395 (schema)Input schema for the 'user_invite' tool defining parameters: studio (optional), emails (required array), productIds (optional array).inputSchema: { type: "object", properties: { studio: studioParam, emails: { type: "array", items: { type: "string" }, description: "Array of email addresses to invite", }, productIds: { type: "array", items: { type: "string" }, description: "Array of product IDs to grant access to", }, }, required: ["emails"], },
- src/index.ts:568-574 (handler)Handler for 'user_invite' tool: sends POST request to Pickaxe API /studio/user/invite with emails and productIds, returns JSON response.case "user_invite": { const result = await pickaxeRequest("/studio/user/invite", "POST", { emails: args.emails, productIds: args.productIds, }, studio); return JSON.stringify(result, null, 2); }