Skip to main content
Invite a user to a project by email

Tool details

FieldValue
Namecreate_invite
GroupMembers

Playground

Input schema

Input schema
{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "description": "Project ID or slug"
    },
    "email": {
      "type": "string",
      "description": "Email address of the user to invite"
    },
    "role": {
      "type": "string",
      "enum": [
        "admin",
        "editor",
        "viewer"
      ],
      "description": "Role to assign (default: editor)"
    }
  },
  "required": [
    "project_reference",
    "email"
  ],
  "additionalProperties": false,
  "description": "Input schema for the create_invite tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Output schema

Output schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the returned record."
    },
    "email": {
      "type": "string",
      "description": "The email associated with this tool result."
    },
    "role": {
      "type": "string",
      "description": "The role associated with this tool result."
    },
    "project_id": {
      "type": "string",
      "description": "Project identifier associated with this result."
    }
  },
  "required": [
    "id",
    "email",
    "role",
    "project_id"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the create_invite tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}