Skip to main content
Glama
Tunzaa

Tunzaa MCP Server

Official
by Tunzaa

get_installment_plan

Retrieve details for a specific installment plan by plan_id, including status and schedules; optionally include completed payments and progress totals.

Instructions

Get details of a specific installment plan. Use this to see the precise fields returned for a plan (status, schedules, etc.).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
addressNo
plan_idYesThe unique numeric ID of the installment plan.
include_paymentsNoAppend ?include_payments=true to also receive completed payment history and progress totals.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.1.0
    • addedInput schema / properties / include_payments
      Added value: +{
      +  "description": "Append ?include_payments=true to also receive completed payment history and progress totals.",
      +  "type": "boolean"
      +}
  2. First observedv1.0.0

TDQS

B3.2/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full behavioral burden. It does not state whether the call is a safe read, what happens when plan_id does not exist, what auth is needed, or how the response is shaped beyond a vague 'status, schedules, etc.'

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?

Two short sentences, front-loaded with the core action, with no filler. The second sentence is slightly redundant and vague ('precise fields'), but nothing is wasted at length.

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

Completeness3/5

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

For a simple read tool with no output schema and no annotations, an agent needs the safety profile and the error/missing-record behavior, neither of which appears. The mention of returned fields partially fills the no-output-schema gap but does not name the address parameter.

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 67%: plan_id and include_payments already have schema descriptions, including the query-string mechanics of include_payments. The description adds no parameter guidance at all and leaves the undocumented 'address' parameter entirely unaddressed, so it does not compensate for the coverage gap.

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

Purpose4/5

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

States a specific verb and resource (get a single installment plan) and hints at the content returned (status, schedules). It does not explicitly differentiate from the closest sibling, list_installments, so an agent must infer that this is the single-record lookup versus the collection listing.

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 second sentence implies when to use it (to inspect the precise fields of a plan), but there is no explicit when-not, no prerequisite, and no named alternative such as list_installments for browsing. Usage is only implied.

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