Skip to main content
Glama

Get Instances Payables

GetV1InstancesPayables
Read-onlyIdempotent

Retrieve and filter payables for a specific instance by status, type, customer, and beneficiary, with pagination controls for browsing results.

Instructions

List Payables

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": {
      "instance_id": "<instance_id>"
    },
    "name": "GetV1InstancesPayables"
  }
}

Input Schema

NameRequiredDescriptionDefault
typeNo
limitNoNumber of items to return
offsetNoNumber of items to skip
statusNo
customer_idNo
instance_idYes
customer_nameNo
ending_beforeNoA cursor for use in pagination. ending_before is an object ID that defines your place in the list.
starting_afterNoA cursor for use in pagination. starting_after is an object ID that defines your place in the list.
beneficiary_nameNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.9.3

TDQS

D1.6/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is covered. The description adds nothing beyond that—no note on pagination behavior, filter combination semantics, default page size, or ordering of results.

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

Conciseness2/5

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

Two words are technically concise but represent under-specification rather than efficiency. There is nothing front-loaded because there is effectively no content.

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

Completeness1/5

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

For a 10-parameter, filter-and-paginate list endpoint with no output schema, the description is wholly inadequate—it explains neither the resource, the filters, the pagination contract (limit/offset vs. ending_before/starting_after), nor what is returned.

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

Parameters1/5

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

Ten parameters with only 40% schema description coverage, yet the description mentions none of them. The enum-bearing filters (type, status, limit, offset) and free-text filters (customer_name, beneficiary_name) are left undocumented in prose, so the description fails to compensate for the coverage gap.

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

Purpose2/5

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

"List Payables" restates the tool name/title rather than explaining what a payable is or how the listing behaves. It does not distinguish this collection endpoint from siblings like GetV1InstancesPayablesById or PostV1InstancesPayables.

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

Usage Guidelines1/5

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

There is no guidance on when to use this versus GetV1InstancesPayablesById, the create/delete payables tools, or other instance-scoped list endpoints. An agent must infer everything from the tool name and schema.

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

Deploy Server

Other Tools