Skip to main content
Glama

Look up a ProAbono Live API endpoint or object

get_api_reference

Fetch the exact contract for a ProAbono API endpoint or object - parameters, required fields, request body schema, responses - before calling the API so parameter names and shapes come from the contract.

Instructions

Returns the exact contract of a ProAbono Live API endpoint (parameters, whether each is required, request body schema, responses) or of a named object such as Customer, Subscription, Offer, Feature or Usage. Use it before calling or generating a call to the ProAbono API, so parameter names and shapes come from the contract rather than from memory.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
objectNoA schema name, e.g. "Customer", "SubscriptionRequest", "Usage".
endpointNoAn endpoint path or fragment, e.g. "/v1/Customer" or "subscription".

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.0.1

TDQS

A3.9/5.0
Behavior3/5

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

With no annotations, the description carries the full behavioral burden. It describes the returned contract and implies a read-only lookup, but it does not explicitly state that the tool has no side effects or require any authentication context. This is adequate for a reference lookup but leaves some behavioral assumptions implicit.

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 focused sentences: the first states what the tool returns, the second states when to use it. Every phrase earns its place, and the key information is front-loaded.

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?

The description explains the return value at a high level and gives usage context, which is useful given there is no output schema. However, both parameters are optional in the schema and the description does not clarify that at least one of object or endpoint is needed, nor what happens when both are supplied.

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 description coverage is 100%, so the input schema already documents both parameters. The description adds examples like Customer, Subscription, Offer, Feature or Usage, but these are illustrative rather than essential to understanding the parameters.

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?

The description states a specific verb ('Returns') and resource ('the exact contract of a ProAbono Live API endpoint... or of a named object'), with concrete examples like Customer and Subscription. This clearly distinguishes it from the action-oriented sibling tools such as create_customer or list_subscriptions.

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

Usage Guidelines4/5

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

It explicitly says to use this tool 'before calling or generating a call to the ProAbono API,' giving a clear intended context. It does not name alternatives or exclusions, but the guidance is specific enough for an agent to know when to reach for it.

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