Get a payment
learnworlds_get_paymentFetch one payment by payment id or transaction id. LearnWorlds: GET /v2/payments/{id}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| payment_id | Yes | The payment id or the transaction id. |
learnworlds_get_paymentFetch one payment by payment id or transaction id. LearnWorlds: GET /v2/payments/{id}.
| Name | Required | Description | Default |
|---|---|---|---|
| payment_id | Yes | The payment id or the transaction id. |
Changes observed during successful MCP inspections.
Input schema / $schemaPrevious value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
readOnlyHint=true already tells the agent this is a safe read, so the description's main addition is the GET endpoint and the id-path semantics. It does not cover failure modes (unknown id), auth requirements, or what a missing payment returns, which would have raised it above baseline.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two tight sentences with the core action front-loaded and the identifier flexibility immediately after; the API route is a compact trailing detail. No wasted words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a single-parameter read tool with annotations and no output schema, the description covers the action, the identifier options, and the endpoint. Only edge-case behavior (not-found, permissions) is left unstated, which is a minor gap.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% and the single parameter's description already says "The payment id or the transaction id." The description repeats that fact with no added syntax, format, or prefix guidance, so the baseline 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ("Fetch one payment") plus the accepted identifier types, and adds the underlying API route. The singular "one payment" implicitly separates it from the sibling learnworlds_list_payments, though that sibling is never named.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Usage is implied rather than stated: an agent infers this is the tool to use when it already has a payment or transaction id. There is no explicit when-to-use/when-not-to-use guidance and no named alternative for bulk retrieval.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.