DocsTools Clans

Tools: Clans

The Clans tools your agent sees through Elixir MCP: what each one answers, what it takes, and which capability it needs.

‹ All tools

Clans

6 of the 55 tools in the registry. Generated from what tools/list returns, so this is exactly what your agent sees.

Clan members' timeline clans_members_timeline

The members' daily series for a clan, yours by default: for every player the roster placed in the clan in the window (or player_tags), one point per game day with the roster's metrics (trophies, donations, donations_received, arena_id, clan_rank, previous_clan_rank, game_last_seen_at) and, for members whose profile is recorded, any profile metric of players_timeline. Names are the current ones. kind selects the pre_reset or season_roll row; granularity week keeps each ISO week's last row. verbosity compact keeps each member's first and last point and the delta.

Read-only · requires cr:read

ArgumentTypeRequiredNotes
clan_tag string no Clan tag like #J2RGCRVG. Omit to mean your recorded clan.
player_tags array no A subset of members; omit for every player the roster placed in the clan in the window.
metrics array no Which series to return; default trophies and donations.
from string no YYYY-MM-DD, inclusive. Built from daily snapshots, so only whole days are meaningful; an instant is not accepted.
to string no YYYY-MM-DD, inclusive. Built from daily snapshots, so only whole days are meaningful; an instant is not accepted.
days integer no Last N days of the series, today included: sugar for from. Or use from/to.
weeks integer no Last N weeks of the series, today included: sugar for from. Or use from/to.
timezone string no IANA zone (e.g. Europe/Paris) for this call's date-only bounds and local labels. Default: the account's timezone. Agents serving people in several zones pass the asker's.
granularity string no week returns the last row of each ISO week. (day · week)
kind string no Which row of the day: daily (the day's last observation), pre_reset (the hour before the Monday 00:10 UTC donation reset: the honest weekly donation total) or season_roll (the hour before the season rolls). (daily · pre_reset · season_roll)
limit integer no Most members to return (by tag order); pass player_tags to choose.
verbosity string no compact: per member the first and last point and the delta of each numeric metric, no series. (full · compact)

What comes back (declared outputSchema; fields marked required are always present):

FieldTypeRequiredNotes
clan_tag string yes Clash Royale tag, e.g. #20JJJ2CCRU.
applied object yes
member_count integer yes
members array yes
notes array yes One-sentence caveats to repeat when quoting the numbers.
docs string yes page or page#section for elixir_docs / elixir://docs.
meta object yes The envelope (docs: responses).

Clan participation by week clans_participation

Every open member's participation, week by week, in ONE call: per ISO week the battles played, ranked battles and the donation counter at week end; per recorded war week the decks used and each war day's decks (null where the day was not polled); per member the observed join, whether that join predates the recording, the last recorded battle and days since it. Facts with their windows and the recording horizon, no rating or ranking: the raw material for any clan's own participation rules. weeks 1 to 8, default 5; the current week is partial and says so. verbosity compact drops the per-day war arrays and points.

Read-only · requires cr:read

ArgumentTypeRequiredNotes
clan_tag string no Clan tag like #J2RGCRVG. Omit to mean your recorded clan.
weeks integer no How many ISO weeks back, the current partial week included.
verbosity string no compact: war_decks only; no per-day arrays, no war_points. (full · compact)

Clan Pilot Scores clans_pilot_scores

Every open member's Pilot Score in ONE call: each member with >= 30 decided leveled battles scored against the corpus Level Curve over the window (default 90 days), with tenure. Descriptive in-sample residuals, not a skill ranking or proof of improvement.

Read-only · requires cr:read

ArgumentTypeRequiredNotes
clan_tag string no Clan tag like #J2RGCRVG. Omit to mean your recorded clan.
days integer no Window for the curve and the scores, ending now.

Clan roster clans_roster

A clan's roster, yours by default: roles, latest trophies and donations per member, activity recency (last recorded battle and the game's own last-seen), the member's tenure and badge count, the lifetime block as of the latest profile poll (best trophies, battles, wins, losses, three-crown wins, collection level, king tower level, total donations; null for a member whose profile is not recorded), and recent join/leave/role events. verbosity compact answers 'how many members' and 'what is this clan called' with the name, the count and the role breakdown only. live: true asks for a fresh read of ANY clan, recorded or not: served if in hand, otherwise queued while the record answers with live_status pending.

Read-only · requires cr:read · reaches the live Clash Royale API, outside the recorded corpus

ArgumentTypeRequiredNotes
clan_tag string no Clan tag like #J2RGCRVG. Omit to mean your recorded clan.
verbosity string no compact: name, member count and role counts only; no member list, no events. (full · compact)
live boolean no Ask for a read of this clan no older than two minutes; works for a clan nobody records. Served if in hand, otherwise queued while the record answers with live_status pending.

What comes back (declared outputSchema; fields marked required are always present):

FieldTypeRequiredNotes
clan_tag string yes Clash Royale tag, e.g. #20JJJ2CCRU.
applied object yes
name string | null yes
member_count integer yes
role_counts object no
members array no
events_recorded_since string | null no
recent_events array no
notes array no One-sentence caveats to repeat when quoting the numbers.
docs string no page or page#section for elixir_docs / elixir://docs.
meta object yes The envelope (docs: responses).

Clan standings clans_standings

Clan-relative performance, yours by default: every open member's recorded W/L/D, win rate, ladder trophy net and current streak in ONE call over a window (default 30 days). For a 24-hour member scan use days: 1, min_battles: 1; from/to also supports shorter windows. Ranked with the clan median; members below min_battles are listed below the floor. Per-battle detail for one member is battles_performance.

Read-only · requires cr:read

ArgumentTypeRequiredNotes
clan_tag string no Clan tag like #J2RGCRVG. Omit to mean your recorded clan.
from string no Start of the window, inclusive: an ISO instant, or YYYY-MM-DD resolving to local midnight in your timezone.
to string no End of the window, exclusive: an ISO instant as given; YYYY-MM-DD covers that WHOLE local day. Omit for up to now.
days integer no Last N days (default 30); or use from/to.
weeks integer no Last N weeks, ending now: sugar for from. Or use from/to.
timezone string no IANA zone (e.g. Europe/Paris) for this call's date-only bounds and local labels. Default: the account's timezone. Agents serving people in several zones pass the asker's.
min_battles integer no Decided battles (wins + losses) required to be ranked.
mode string no Mode group: ladder (Trophy Road), ranked (Path of Legends), war, casual, challenge, tournament. Omit for every mode. (casual · challenge · ladder · ranked · tournament · war)

What comes back (declared outputSchema; fields marked required are always present):

FieldTypeRequiredNotes
clan_tag string yes Clash Royale tag, e.g. #20JJJ2CCRU.
applied object yes
ranked_members integer yes
median_win_rate number | null yes 0..1, three decimals; null when the denominator is zero.
members array yes
below_floor array yes
notes array yes One-sentence caveats to repeat when quoting the numbers.
docs string yes page or page#section for elixir_docs / elixir://docs.
meta object yes The envelope (docs: responses).

Clan timeline clans_timeline

A clan's daily series, yours by default, one point per game day from the roster: clan_score, clan_war_trophies, members, donations_per_week, required_trophies, and the aggregates over that day's member rows (total_member_trophies, avg_member_trophies, members_seen); the profile-derived aggregates (avg_member_wins, avg_member_collection_level, the 12000+/14000+/6-years+/collection-1000+ counts) are metrics to ask for. kind selects the pre_reset or season_roll row; granularity week keeps the last row of each ISO week. verbosity compact keeps day and the five clan metrics.

Read-only · requires cr:read

ArgumentTypeRequiredNotes
clan_tag string no Clan tag like #J2RGCRVG. Omit to mean your recorded clan.
metrics array no Which series to return; default the five clan metrics and the three roster aggregates.
from string no YYYY-MM-DD, inclusive. Built from daily snapshots, so only whole days are meaningful; an instant is not accepted.
to string no YYYY-MM-DD, inclusive. Built from daily snapshots, so only whole days are meaningful; an instant is not accepted.
days integer no Last N days of the series, today included: sugar for from. Or use from/to.
weeks integer no Last N weeks of the series, today included: sugar for from. Or use from/to.
timezone string no IANA zone (e.g. Europe/Paris) for this call's date-only bounds and local labels. Default: the account's timezone. Agents serving people in several zones pass the asker's.
granularity string no week returns the last row of each ISO week. (day · week)
kind string no Which row of the day: daily (the day's last observation), pre_reset (the hour before the Monday 00:10 UTC donation reset: the honest weekly donation total) or season_roll (the hour before the season rolls). (daily · pre_reset · season_roll)
verbosity string no compact: day and the five clan metrics per point. (full · compact)

What comes back (declared outputSchema; fields marked required are always present):

FieldTypeRequiredNotes
clan_tag string yes Clash Royale tag, e.g. #20JJJ2CCRU.
applied object yes
series_available_from string | null yes
series array yes
notes array yes One-sentence caveats to repeat when quoting the numbers.
docs string yes page or page#section for elixir_docs / elixir://docs.
meta object yes The envelope (docs: responses).