Skip to main content
Glama

DSSR allowances by location post code

get_allowances_by_postcode
Read-onlyIdempotent

Returns DSSR allowances (COLA, hardship, LQA, danger pay, education, per diem) for the post identified by its five-digit DSSR post code, today or on date. Post codes are the State Department's own identifiers and come back in every DSSR result, so this is the most precise lookup. Use get_allowances_by_location for a name, get_allowances for the whole country. Posts the State Department removed return no allowances after their last listing. History starts on 2008-01-01.

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": {
      "postcode": "<postcode>",
      "country_iso_code": "<country_iso_code>"
    },
    "name": "get_allowances_by_postcode"
  }
}

Input Schema

NameRequiredDescriptionDefault
dateNoThe day the rates must be in force, YYYY-MM-DD, from 2008-01-01 on; today when omitted. Plan limits: Sandbox and Google add-on accounts may query dates within 30 days of today, Pro the current and previous US fiscal year, Business any date.
typeNoFilter returned allowances. Unknown values are ignored.<br/>If not specified, all allowances are returned.<br/>Canonical values: cola, hardship, lqa, danger_pay, education, perdiem.<br/>Aliases accepted: cost_of_living, cost-of-living, danger, danger-pay, livingquarters.
postcodeYes5-digit DSSR post code (no zero-padding)
country_iso_codeYesISO 3166-1 alpha-2 country code, e.g. PG for Papua New Guinea; ZZ stands for 'Other Foreign Localities', not a country. Resolve a country name to its code with get_countries (q=name).
verification_urlNoIncluded by default: a link to the official government table for the returned location and date, for the user to confirm the figures. Pass false to omit it.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / date / description
      Previous value: -"The day the rates must be in force, YYYY-MM-DD; today when omitted. Plan limits: Sandbox and Google add-on accounts may query dates within 30 days of today, Pro the current and previous US fiscal year, Business any date."New value: +"The day the rates must be in force, YYYY-MM-DD, from 2008-01-01 on; today when omitted. Plan limits: Sandbox and Google add-on accounts may query dates within 30 days of today, Pro the current and previous US fiscal year, Business any date."
  2. Changed1 schema field changed
    • changedInput schema / properties / date / description
      Previous value: -"Specific date in YYYY-MM-DD format"New value: +"The day the rates must be in force, YYYY-MM-DD; today when omitted. Plan limits: Sandbox and Google add-on accounts may query dates within 30 days of today, Pro the current and previous US fiscal year, Business any date."
  3. Changed2 schema fields changed
    • changedInput schema / properties / verification_url / default
      Previous value: -falseNew value: +true
    • changedInput schema / properties / verification_url / description
      Previous value: -"If 'True', will include a verification url in the payload, pointing to the official government source. This is useful to crosscheck that the API returns the proper data and for auditing."New value: +"Included by default: a link to the official government table for the returned location and date, for the user to confirm the figures. Pass false to omit it."
  4. First observed

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive and closed-world, so the safety profile needs no restating. The description adds real behavioral context beyond them: the historical horizon and the fact that delisted posts return empty results after their last listing. It does not describe pagination or the shape of a returned record, keeping it just below the top mark.

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?

Four sentences, front-loaded with purpose and allowance types, then alternatives, then behavioral caveats. No sentence restates the title or the schema, and the progression from what it does to when to use it to edge cases is easy to scan.

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?

For a read-only lookup with full schema coverage and rich annotations, the description covers purpose, alternatives, and historical caveats adequately. The one remaining gap is that no output schema exists and the description never characterizes the returned allowance records, leaving an agent to infer the response shape.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3, but the description adds provenance the schema lacks: post codes are the State Department's own identifiers and appear in every DSSR result, which tells an agent where to source the required postcode. It also clarifies the default-to-today semantics of `date`, though it does not touch `type` or `verification_url` beyond what the schema already explains.

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?

States a specific verb and resource ("Returns DSSR allowances") plus the enumerated allowance types and the exact key used (five-digit DSSR post code). It also distinguishes itself from get_allowances_by_location and get_allowances within the description itself, so an agent can route without opening any schema.

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

Usage Guidelines5/5

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

Explicit routing guidance: use get_allowances_by_location for a name and get_allowances for the whole country, with the claim that post-code lookup is the most precise. Adds a temporal boundary (history starts 2008-01-01) and the caveat that removed posts return no allowances after their last listing.

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.

Resources