Skip to main content
Glama

Get charge

charges_get
Read-only

Fetch a single Klappay charge by ID to retrieve its status, settlement status, amounts, accepted payment pairs, split recipients, and timestamps; include metadata only when requested.

Instructions

Fetch one charge by id: status, settlement status, amounts, accepted payment pairs, split recipients and timestamps. metadata is left out unless includeMetadata is true.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "id": "<id>"
    },
    "name": "charges_get"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesA Klappay charge id (`ch_` followed by letters and digits).
includeMetadataNoInclude each charge's free-form `metadata` object (merchant-supplied data, may hold customer details). Omitted unless true.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered. The description earns credit beyond that by disclosing the actual payload shape and, importantly, the non-obvious default that `metadata` is silently omitted unless includeMetadata is true — a behavioral quirk an agent cannot learn from the annotations. It doesn't cover error behavior (e.g., unknown id), which keeps it below 5.

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?

Two sentences, zero filler. The core action and returned fields are front-loaded, and the metadata caveat follows as a compact qualifier. Every clause carries information an agent would otherwise have to discover by calling the tool.

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?

With no output schema, enumerating the returned fields is exactly the right compensation and it is done adequately. For a two-parameter read tool whose annotations carry the safety profile, only failure-mode behavior (not found, invalid id) is missing, which is a minor gap rather than a blocker.

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 coverage is 100%, so both parameters are already fully documented in the schema, including the `ch_` id pattern and the includeMetadata default of false. The description restates the metadata omission rule, which mildly reinforces the semantics but adds no format or constraint detail beyond the schema. Baseline 3 applies when the schema does the heavy lifting.

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 ("Fetch one charge by id") and immediately enumerates what comes back: status, settlement status, amounts, accepted payment pairs, split recipients, timestamps. The word "one" implicitly separates it from the list/timeline siblings, so an agent knows this is a single-record retrieval without opening any schema.

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 phrase "by id" implies the precondition (you need a charge id) and "one charge" hints at the list alternative, but there is no explicit when-to-use or when-not-to-use guidance. Nothing points the agent to charges_list for multiple charges or charges_timeline for history, so the routing is left to inference.

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