Skip to content

Misc

Reference for the 8 CryptoComply MCP tools in the Misc family.

Tools in this group

analytics_summary

Read-only: yes.

Return aggregate counts for an organization: open alerts, profiles by review status, blockchain addresses by risk, and profile inquiries by resolution. Use for the "what's the state of my book today?" opener.

Optional breakdown_by adds drill-down dimensions; supported values: profile_group (adds profiles grouped by ProfileGroup), risk (adds profiles grouped by risk rating). Omit for the default shape.

Returns {open_alert_count, profiles_by_review_status, blockchain_addresses_by_risk, profile_inquiries_by_resolution} plus any requested breakdowns.

Parameters

  • organization_id (Annotated[int, Field(description='Organization to summarise.')], required) — (no description)
  • breakdown_by (Annotated[list[str] | None, Field(description="Optional list of additional drill-down dimensions. Supported: 'profile_group', 'risk'.")], optional) — (no description)

country_list

Read-only: yes.

List countries from the ISO 3166-1 catalog. Use to resolve alpha-2 codes (e.g. 'IR'), alpha-3 codes ('IRN'), or names ('Iran') for profile creation, citizenship updates, jurisdiction audits, etc. Optional query substring-matches against name and both ISO codes (case-insensitive).

Returns a flat list of {id, alpha2, alpha3, english_name}. No pagination (the full catalog is ~250 entries).

Parameters

  • query (Annotated[str | None, Field(description='Case-insensitive substring matched against english_name, alpha2, and alpha3. Omit to return all countries.')], optional) — (no description)
  • limit (Annotated[int, Field(ge=1, le=300, description='Max rows to return.')], optional) — (no description)

list_my_organizations

Read-only: yes.

List every organization the authenticated user belongs to. Call this first to learn which organization_id values are valid for the other tools.

Returns {count, limit, offset, has_more, results} where each result is {organization_id, name, role}.

me

Read-only: yes.

Return the authenticated user's full profile inside a specific organization: identity, role, permissions, and feature flags. Mirrors the REST /api/v1/organizations/<id>/users/me/ endpoint so MCP-driven workflows can answer 'what role do I have here?', 'which permissions am I granted?', and 'which feature flags apply to me in this org?' from a single call. Use whoami instead when you only need the user's global identity (no organization context).

Returns {user_id, username, email, first_name, last_name, full_name, date_joined, last_login, is_staff, is_superuser, membership_id, organization_id, organization_name, role: {id, name, description, permissions: [codename, ...]}, feature_flags: [name, ...]}.

Parameters

  • organization_id (Annotated[int, Field(description="Organization to read the caller's membership for.")], required) — (no description)

member_list

Read-only: yes.

List members of an organization with their roles. Use when the user asks about team members, who has access, or who owns what.

Returns {count, limit, offset, has_more, results} where each result is {user_id, email, full_name, role}.

Parameters

  • organization_id (Annotated[int, Field(description='Organization whose members to list.')], required) — (no description)
  • role_id (Annotated[int | None, Field(description='Filter by role id.')], optional) — (no description)
  • limit (Annotated[int, Field(ge=1, le=100, description=LIMIT)], optional) — (no description)
  • offset (Annotated[int, Field(ge=0, description=OFFSET)], optional) — (no description)

relationship_type_list

Read-only: yes.

List valid relationship-type codes for profile_related_add / profile_related_update. Codes include ULTIMATE_BENEFICIAL_OWNER, CONTROL_PERSON, PARENT_ENTITY/CONTROLLING_ENTITY, COMPLIANCE_OFFICER, OTHER.

Returns [{code, label, description: null}]. Always returns the full enum.

screening_frequency_options

Read-only: yes.

List screening-frequency options ('N'=Never, 'D'=Daily, 'W'=Weekly, 'M'=Monthly, 'Q'=Quarterly, 'Y'=Yearly). Use before calling profile_update or blockchain_address_update with a screening_frequency argument so you submit a valid code.

Each row carries the code, human label, and (where applicable) the cadence in days. Always returns the full enum — no filtering.

whoami

Read-only: yes.

Return the CryptoComply identity of the bearer-token holder. Use when the user asks 'who am I?' or 'which account am I authenticated as?' — the answer is always derived from the validated JWT, never inferred from the model's session context, and is the ground truth for every other tool call.

Returns {user_id, username, email, full_name, is_staff, is_superuser}.