Skip to main content
Glama

goteamup

List customer memberships

goteamup_list_customer_memberships
Read-only

List memberships held by customers — status (active, hold, complete, cancelled), start/expiration/renewal dates, billed price, active hold. Filter by customer, membership plan, type, status, dates or holds. TeamUp: GET /customer_memberships.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idsNoOnly these customer membership ids.
pageNoPage number, starting at 1.
sortNoOrdering; '-' for descending.
expandNoComma-separated related fields to expand into full objects (dot-nested, max depth 4), e.g. customer,event.instructors.
fieldsNoComma-separated fields to return (dot notation for nested), e.g. id,name,starts_at.
statusNoCustomer membership status.
customerNoOnly these customer ids.
page_sizeNoResults per page, 1-100 (default 100).
membershipNoOnly these membership (plan) ids.
start_date_gteNoStart date on or after (date, YYYY-MM-DD).
start_date_lteNoStart date on or before (date, YYYY-MM-DD).
has_active_holdNoOnly memberships with (true) or without (false) a current or upcoming hold.
membership_typeNoMembership type.
expiration_date_gteNoExpiration date on or after (date, YYYY-MM-DD).
expiration_date_lteNoExpiration date on or before (date, YYYY-MM-DD).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

readOnlyHint=true already establishes this as a safe read, so the bar is lower. The description adds the underlying endpoint (GET /customer_memberships) and the returned field set (status, dates, billed price, active hold), which is useful context, but says nothing about pagination behavior or how the default 100-per-page interacts with filtering.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two compact sentences front-load the returned fields and filter options, then close with the API endpoint. No filler, though the parenthetical status enumeration duplicates the schema enum rather than adding value.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a rich 15-parameter read tool with full schema coverage and no output schema, the description covers what is returned (statuses, dates, billed price, hold state) and what can be filtered. It is close to complete; only pagination/return-shape behavior is left to the schema.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents all 15 parameters, including the status enum and date bounds. The description's filter list ('customer, membership plan, type, status, dates or holds') only restates those parameters at a higher level without adding format or constraint detail, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('List memberships held by customers') with clear scope. It implies a distinction from plan-level listings, but never names the sibling tools goteamup_list_memberships or goteamup_get_customer_membership, so differentiation depends on inference.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description enumerates filterable dimensions (customer, membership plan, type, status, dates, holds), which implies the contexts in which the tool is useful, but it gives no explicit when-to-use, when-not, or alternative-tool guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.