Skip to main content
Glama

Pair Rate Differentials

rate_differentials
Read-only

Return the stored or derived rate differential for one FX pair, with the measure, rate type, curve family, and tenor metadata that define it. Access: requires an FXMacroData API key; an anonymous call returns subscription_required with a subscribe link.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
baseYesBase currency code.
limitNoMaximum rows to return.
quoteYesQuote currency code.
offsetNoZero-based row offset.
measureNoShared rate measure to compare across the pair.auto
end_dateNoOptional inclusive end date, YYYY-MM-DD.
rate_typeNoDifferential type: spot or forward.spot
start_dateNoOptional inclusive start date, YYYY-MM-DD.
curve_familyNoCurve family when rate_type is forward.government_nominal
end_tenor_yearsNoEnd tenor in years for forward differentials.
start_tenor_yearsNoStart tenor in years for forward differentials.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed11 schema fields changed
    • removedInput schema / properties / base / title
      Removed value: -"Base"
    • removedInput schema / properties / curve_family / title
      Removed value: -"Curve Family"
    • removedInput schema / properties / end_date / title
      Removed value: -"End Date"
    • removedInput schema / properties / end_tenor_years / title
      Removed value: -"End Tenor Years"
    • removedInput schema / properties / limit / title
      Removed value: -"Limit"
    • removedInput schema / properties / measure / title
      Removed value: -"Measure"
    • removedInput schema / properties / offset / title
      Removed value: -"Offset"
    • removedInput schema / properties / quote / title
      Removed value: -"Quote"
    • removedInput schema / properties / rate_type / title
      Removed value: -"Rate Type"
    • removedInput schema / properties / start_date / title
      Removed value: -"Start Date"
    • removedInput schema / properties / start_tenor_years / title
      Removed value: -"Start Tenor Years"
  2. Added

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, openWorldHint=true and destructiveHint=false, so safety is covered. The description adds real behavioral context beyond that: the auth requirement and the concrete failure mode for anonymous callers (subscription_required with a subscribe link), plus the note that the differential may be 'stored or derived'.

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, with the core purpose front-loaded and the access constraint second. Every clause earns its place.

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?

An output schema exists, so return-value explanation is unnecessary, and the auth/error behavior is disclosed. The remaining gap is the absence of routing guidance against a crowded sibling set, but for a single read-only lookup the description is otherwise sufficient.

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 all 11 parameters are already documented in the schema, and the description adds no syntax, defaults, or constraints beyond naming the same metadata fields. Baseline 3 applies when the schema carries the parameter burden.

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?

The description names a specific verb and resource ('Return the stored or derived rate differential for one FX pair') and lists the defining metadata (measure, rate type, curve family, tenor). It is clear, though it does not explicitly distinguish itself from adjacent siblings like rate_curve or policy_rate_differential_visual_artifact.

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

Usage Guidelines2/5

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

There is no statement of when to choose this tool over alternatives such as rate_curve or the policy-rate differential visual artifact tools. The only guidance is an access prerequisite (API key required, anonymous calls return subscription_required), which is not usage selection guidance.

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.