Skip to main content
Glama
thenavidm
by thenavidm

List all commissions

list_commissions
Read-onlyIdempotent

Retrieve a paginated set of commissions for your partner program, filtering by status, type, date, partner, payout, or invoice to track earnings and manage payouts.

Instructions

Retrieve a paginated list of commissions for your partner program.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
endNoThe end date of the date range to filter the commissions by.
pageNoDEPRECATED. Use `startingAfter` instead.
typeNoFilter the list of commissions by type. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: - "sale" - "sale,lead" - "-click"
queryNoFilter by lead or sale event metadata. Top-level keys only. Compares string values only — numeric and boolean metadata values are not matched. Examples: - "metadata['key']='value'" - "metadata['key']!='value'"
startNoThe start date of the date range to filter the commissions by.
statusNoFilter the list of commissions by their corresponding status.
accountNoExact configured private workspace profile label; not a tenant or provider account ID.
sort_byNoThe field to sort the list of commissions by.createdAt
group_idNoFilter the list of commissions by the associated partner group. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: - "group_abc" - "group_abc,group_xyz" - "-group_abc"
intervalNoThe interval to retrieve commissions for.all
timezoneNo
page_sizeNoThe number of items per page.
payout_idNoFilter the list of commissions by the associated payout.
tenant_idNoFilter the list of commissions by the associated partner's `tenantId` (their unique ID within your database).
invoice_idNoFilter the list of commissions by the associated invoice. Since invoiceId is unique on a per-program basis, this will only return one commission per invoice.
partner_idNoFilter the list of commissions by the associated partner. When specified, takes precedence over `tenantId`. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: - "partner_abc" - "partner_abc,partner_xyz" - "-partner_abc"
sort_orderNoThe sort order for the list of commissions.desc
customer_idNoFilter the list of commissions by the associated customer.
ending_beforeNoIf specified, the query only searches for results before this cursor. Mutually exclusive with `startingAfter`.
partner_tag_idNoFilter the list of commissions by the associated partner tag. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: - "ptag_abc" - "ptag_abc,ptag_xyz" - "-ptag_abc"
starting_afterNoIf specified, the query only searches for results after this cursor. Mutually exclusive with `endingBefore`.
bounty_submission_idNoFilter the list of commissions by the associated bounty submission.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=true, so the safety profile is covered by structured data. The description's one addition beyond that is the paginated nature of the result set, which is useful but thin given the 22-parameter surface and cursor-based pagination the schema exposes.

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?

A single front-loaded sentence with no filler or repetition. It is efficient, though the terseness is arguably under-specification for a tool with 22 parameters, which is better penalized under completeness than conciseness.

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

Completeness3/5

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

For a 22-parameter read tool with no output schema, the description covers the essence (paginated list of commissions) and lets the rich schema handle filters. It omits any pointer about cursor pagination (startingAfter/endingBefore) and the deprecated page parameter, which are the two areas most likely to trip up an agent, so it is adequate but not complete.

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 95% across the 22 properties, so the schema already carries nearly all parameter meaning, including enum values and advanced-filter syntax. The description adds no parameter detail at all, so the baseline of 3 applies rather than a higher score.

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?

The description pairs a specific verb ('Retrieve') with a specific resource ('a paginated list of commissions') and scopes it to 'your partner program'. It does not, however, distinguish this tool from sibling list tools such as list_payouts, list_partners, or list_bounty_submissions, leaving the agent to infer the difference from the name alone.

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

Usage Guidelines2/5

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

There is no statement of when to use this tool versus alternatives, no mention of the create_commission/update_commission/bulk_update_commissions siblings, and no guidance on scenarios or prerequisites. The only implicit hint is that results are paginated, which the agent must act on without instruction.

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