Skip to main content
Glama

get_payments

Read-onlyIdempotent

Retrieve a paginated list of payments from LearnWorlds, filterable by user, product, affiliate, product type, and creation date.

Instructions

๐ŸŸข READ-ONLY ยท GET /v2/payments

Get payments. Returns a list with all the payments. The payments are in sorted order, with the most recently created payment appearing first, and the list is paginated, with a default limit of 50 payments per page. To refine the list of payments, there are a number of query params outlined in the following section; In case more than one Query param is provided, then all of them will be applied (AND operator).

Behavior: read-only lookup against the live school; creates, changes and deletes nothing. Auth (admin API token + Lw-Client id) is injected server-side, never by the model; calls are throttled to stay under LearnWorlds' 30-per-10s cap and retried on 429/5xx. Parameters: results are paged โ€” walk them with page and size each page with items_per_page. Returns: HTTP <status> followed by the LearnWorlds JSON response body. A non-2xx reply surfaces as a tool error with that status and the API error payload โ€” 401 bad/expired token, 403 not permitted, 404 no such record, 422 rejected input. Use when: safe to call speculatively for lookups and reporting. Not for changing anything โ€” use the matching ๐ŸŸก write tool. Related Payments tools: get_invoice_link_per_payment, get_payment.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoFilter by the page number. In case page number is higher than the maximum one, the results of last page will be returned
user_idNoFilter by user id or email (encoded string)
product_idNoFilter by product id
affiliate_idNoFilter by affiliate id or email (encoded string)
product_typeNoFilter by product type
created_afterNoFilter by payment creation after the given datetime (expected in UNIX timestamp format)
created_beforeNoFilter by payment creation before the given datetime (expected in UNIX timestamp format)
items_per_pageNoFilter by the items per page number

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. First observedv1.0.0

TDQS

A4.9/5.0
Behavior5/5

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

Annotations already declare read-only/idempotent/non-destructive, but the description adds meaningful behavior beyond them: auth is injected server-side, calls are throttled under LearnWorlds' 30-per-10s cap and retried on 429/5xx, and non-2xx responses surface as tool errors with mapped HTTP status meanings. This is rich, actionable behavioral context.

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

Conciseness5/5

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

The description is organized into clear labeled sections (Behavior, Parameters, Returns, Use when) and every sentence carries operational value. The read-only and endpoint info are front-loaded, and there is no filler or repetition of schema details.

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

Completeness5/5

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

For a parameterless-required read-only list tool with no output schema, the description fully covers return format, error behavior, pagination, filtering semantics, auth handling, rate limiting, and usage boundaries. The agent has everything needed to invoke and interpret results correctly.

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

Parameters4/5

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

Schema description coverage is 100%, so each parameter is already documented. The description adds valuable semantic context: multiple query params combine with AND logic, pagination is walked via page and sized via items_per_page, and default page size is 50. This goes beyond the schema's individual parameter descriptions.

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

Purpose5/5

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

States a specific verb and resource: 'Get payments' returns a paginated list sorted by recency. It distinguishes itself from related payment tools by naming get_payment and get_invoice_link_per_payment as separate tools, and by emphasizing the list/pagination behavior.

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

Usage Guidelines5/5

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

Explicitly says when to use: 'safe to call speculatively for lookups and reporting,' and when not to: 'Not for changing anything โ€” use the matching ๐ŸŸก write tool.' This gives the agent clear decision rules, especially against many sibling write tools.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/ohneben/Learnworlds-MCP'

If you have feedback or need assistance with the MCP directory API, please join our Discord server