Skip to main content
Glama

Payment link

evictions_get_payment_link
Idempotent

Use this when the person wants to pay a due charge on a case, or after evictions_submit_case answered payment_required. Input: the case id and the chargeId from that answer or from evictions_list_case_charges. Opens a hosted checkout for one due charge and returns its URL; asked again while that checkout is open, it returns the same URL. Give the URL to the person: paying is theirs to do, and no tool takes card details. Paying a draft’s platform fee submits the case: it moves to submitted when the payment arrives. Refused when the charge is not due or online payment is off, and, with authorization_required, until the person has signed the case’s authorization for us to act as their agent: then give the person the case page link in the error’s details (signAt), where they read and sign it themselves, and ask again. Do not use this to see whether a charge is paid (use evictions_list_case_charges). Needs the person’s account: sign-in or an API key.

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>",
      "chargeId": "<chargeId>"
    },
    "name": "evictions_get_payment_link"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesThe case id (case_...), as returned by evictions_create_case or evictions_list_cases.
chargeIdYesThe id of a due charge on that case, from evictions_list_case_charges.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Goes well past the annotations: it discloses idempotency semantics in human terms (same URL while the checkout is open), refusal conditions (charge not due, online payment off, authorization_required with a signAt link), the side effect that paying a draft's platform fee submits the case, and the auth requirement (sign-in or API key). It also states the boundary that no tool takes card details, which matters for an openWorldHint mutation.

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?

Front-loaded with the use case and input, then behavior, then failure modes. Dense but almost every clause carries decision-relevant information; the authorization_required sentence is long and could be split for readability.

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 2-param mutation with no output schema, it covers invocation, the returned URL, idempotency, side effects, failure modes with recovery steps, and auth needs. An agent can call it and handle the error path without further information.

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 coverage is 100%, so both parameters are already documented; the description still adds provenance value by saying the chargeId may come from evictions_submit_case's `payment_required` answer as well as evictions_list_case_charges. It adds meaning beyond the schema, though not format or constraint detail.

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: "Opens a hosted checkout for one due charge and returns its URL." That is clearly distinguishable from siblings like evictions_list_case_charges (read charge state) and evictions_submit_case (file the case).

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?

Gives explicit triggers ("when the person wants to pay a due charge," or after evictions_submit_case returned `payment_required`) and an explicit exclusion ("Do not use this to see whether a charge is paid (use evictions_list_case_charges)"). It also names a named-alternative dependency for the chargeId source.

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.