Skip to main content
Glama

DSSR allowances by location name

get_allowances_by_location
Read-onlyIdempotent

Returns DSSR allowances (COLA, hardship, LQA, danger pay, education, per diem) for one post in a country matched by name, case-insensitive and partial ('toky' finds Tokyo), today or on date. Find exact post names with get_dssr_locations_by_country or search_perdiem. Use get_allowances_by_postcode when the DSSR post code is known, get_allowances for every post in the 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": {
      "location": "<location>",
      "country_iso_code": "<country_iso_code>"
    },
    "name": "get_allowances_by_location"
  }
}

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.
locationYesLocation name, case insensitive
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.3/5.0
Behavior4/5

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

Annotations already cover read-only, idempotent, closed-world behavior, yet the description still adds real context: case-insensitive partial matching, that removed posts return no allowances after their last listing, and that history begins 2008-01-01. It does not mention plan-based date limits, though the date parameter's schema text does.

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?

Front-loaded with what is returned, then matching semantics, then alternative tools, then the edge case about removed posts. Dense but every sentence carries routing or behavioral information; the allowance-type parenthetical is the only slightly padded element.

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 no output schema, the description compensates by enumerating the allowance types returned and disclosing data-coverage limits (removed posts, history start). Remaining gaps such as plan-based date restrictions are covered by the date parameter's schema text, so an agent can call this correctly.

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 baseline is 3. The description's notes on partial name matching and 'today when omitted' restate what the schema's examples and description already say, adding little new parameter meaning.

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 exact scope: one post, in a country, matched by name, for today or a given date. The parenthetical list of allowance types and the partial-match rule make it unmistakable versus get_allowances_by_postcode or get_allowances.

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?

Explicitly routes the agent: use get_dssr_locations_by_country or search_perdiem to resolve exact post names, get_allowances_by_postcode when the post code is known, and get_allowances for every post in the country. Both prerequisites and alternatives are named.

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