guild_get_prune_count
Estimate how many inactive members would be pruned from a Discord server before starting the prune. Specify inactivity days and optional roles to gauge the kick count.
Instructions
Purpose: Preview how many members would be pruned (kicked) for inactivity.
When to use:
Estimate impact before calling
guild_begin_prune.
days (1..30) is the inactivity threshold.
include_roles WIDENS the prune (does not narrow it). An inactive member is pruned only if ALL of their roles appear in this list; a member holding ANY role not listed is never pruned. Members with no roles are always pruned regardless. Max 100.
Returns: {pruned} (estimated kick count).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| days | No | Inactivity threshold in days (1..30, default 7) | |
| guild_id | Yes | Guild to query | |
| include_roles | No | WIDENS the prune (does not narrow it). An inactive member is pruned only if ALL of their roles appear in this list; a member holding ANY role not listed is never pruned. Members with no roles are always pruned regardless. Max 100. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||