Skip to main content
Glama

Pair Rate Differentials

rate_differentials
Read-only

Return the stored or derived rate differential for one FX pair. Use the returned measure, rate type, curve family, and tenor metadata when explaining the result. 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

A4/5.0
Behavior5/5

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

Annotations already mark the tool as read-only and non-destructive, so the description adds value by stating that results may be stored or derived and that anonymous calls return subscription_required with a subscribe link. It also tells the agent to surface the returned measure, rate type, curve family, and tenor metadata when explaining results. No annotation contradiction is present.

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 with no filler: the first states the action, the second adds result-usage guidance and access behavior. It avoids repeating schema details and remains tightly scoped.

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?

With read-only annotations, an output schema, and a fully documented input schema, the description covers the important operational context: stored/derived behavior, API key requirement, anonymous error response, and how to present results. It could go slightly further by noting date-range or pagination behavior explicitly, but the schema already covers those.

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 schema already documents base, quote, measure, rate_type, date range, pagination, and forward tenor parameters. The description adds no new parameter-specific meaning; its metadata guidance is about how to use the output rather than how to set the inputs.

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 opens with a specific verb and object—'Return the stored or derived rate differential for one FX pair'—so an agent can tell this is a data-retrieval tool rather than a visual artifact tool. It does not explicitly differentiate from close siblings like rate_curve or policy_rate_differential_visual_artifact, but 'for one FX pair' narrows the scope.

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 description implies use when an agent needs a stored or derived rate differential for a single FX pair, and the access note sets expectations for authentication. It does not state when to prefer this tool over siblings such as rate_curve or policy_rate_differential_visual_artifact, nor does it provide explicit exclusions.

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.