invite_model_collaborator

Invite a user to a model by email. Requires Owner role on the model. If the email belongs to an active workspace member, access is granted immediately and they receive a model-access email. Otherwise a pending model grant and workspace invitation are created together — the invitee receives a workspace invite email and both grants are resolved when they sign up.

Parameters

Name	Type	Required	Default	Description
model_name	Annotated[str, Field(description='Name of the Bridge Town model. Caller must have Owner role.')]	Yes	—
email	Annotated[str, Field(description='Email address of the user to invite.')]	Yes	—
role	Annotated[Literal['owner', 'editor', 'viewer'], Field(description="Model role to grant. One of: 'owner', 'editor', 'viewer'.")]	No	'viewer'

Returns

Returns a structured object. Top-level fields:

• grant_id (string)
• model (string)
• email (string)
• role (string)
• pending (boolean)
• workspace_invite (string)

See the response example below for the full payload shape.

Example

Tool Call

{
  "name": "invite_model_collaborator",
  "arguments": {
    "model_name": "forecasts",
    "email": "carol@example.com",
    "role": "editor"
  }
}

Response

{
  "grant_id": "99999999-9999-9999-9999-999999999999",
  "model": "forecasts",
  "email": "carol@example.com",
  "role": "editor",
  "pending": true,
  "workspace_invite": "created"
}

Notes

• Module: Collaborators
• Requires authentication via API token or Auth0 JWT.