Roles Tools
List Roles
Lists available roles.
published
List Roles
Allows the agent to query the roles available in the workspace.
When to enable this tool
Use this tool when the agent needs to see which roles exist in the workspace — to list options when assigning a role, check if a role already exists before creating another, or audit the organizational structure.
Practical examples:
- "What roles exist in the workspace?"
- Check available roles before inviting a new member
- Find a role's ID to assign it to a member
What the agent can do
- List all workspace roles
- Filter by name or status
- View each role's description and icon
Information the agent uses
| Information | Description |
|---|---|
| Name | Optional: filter roles by name |
| Status | Optional: show only active or inactive roles |
Important notes
- Returns a maximum of 100 roles per query
- Inactive roles appear in results unless filtered by status