Skip to main content
Glama

C4C: Mortgage Industry Regulations

Get obligation

get_obligation
Read-onlyIdempotent

Return one obligation's verbatim regulator text with full provenance. Answer with this text: quote it exactly, with its section citation, never a paraphrase (a summary may follow the quotes, labeled as your summary). If currency is not null, tell the user its headline (e.g. two versions apply, a pending revision, superseded, expired) and which version you quoted. For specific requirements in a long section, find_in_section is faster: it returns only the paragraphs containing your terms. Paging: at most 24,000 chars per call (limit asks for fewer). paging says where you are (page N of M) and paging.how says exactly what to do next: while next_offset is a number, call again with the same obligation_id and offset=next_offset; null means the section ends in this response. chars_offset + chars_returned is your position in chars_total. truncated means this response is not the whole section: never assert that the rule does not require something until you have read every page. Two versions: an FHA 4000.1 section Update 18 revises has two obligations, the in-force text and its Update 18 revision (<id>::update-18); version says which this is and other_version gives the other's obligation_id -- quote the one that applies and say which. compare_versions: true adds version_changes: the sentences Update 18 deletes and adds in this section. canonical_citation is the section's citation in the regulator's style (e.g. "4000.1 II.A.5.d", "B3-3.3-07", "38 U.S.C. 3709(b)"; null if not derivable): cite it. If canonical_id is set, this register is a same-text copy of that one. If figures is empty the section states no figure -- say so rather than supplying one from memory.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMax chars to return from offset (200-24000; default 24000). With a find_in_section passage offset, a small limit reads just around it.
offsetNo
obligation_idYes
compare_versionsNoOn an FHA section Update 18 revises: also return `version_changes`, the sentences Update 18 deletes and adds (verbatim units with offsets).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / compare_versions
      Added value: +{
      +  "description": "On an FHA section Update 18 revises: also return `version_changes`, the sentences Update 18 deletes and adds (verbatim units with offsets).",
      +  "type": "boolean"
      +}
  2. First observed

TDQS

A5/5.0
Behavior5/5

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

While annotations already declare readOnly, idempotent, and non-destructive hints, the description goes far beyond them by disclosing paging behavior, truncation semantics, version handling, canonical citation fields, and the instruction not to assert a rule is absent until all pages are read. This adds rich behavioral context that annotations cannot convey. There is no contradiction with the annotations.

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?

The description is long but every sentence carries operational value, covering quoting rules, pagination mechanics, truncation warnings, version ambiguity, and citation output. The core purpose is front-loaded, and the detailed instructions are organized in a logical progression from answer behavior to pagination to version handling. Despite its density, there is no filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/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 must carry the full burden of explaining return values and edge cases. It does so comprehensively: provenance, canonical citation, versions, same-text copies, figures, truncation, and pagination. For a tool of this complexity, nothing an agent needs to call it correctly or interpret its result is missing.

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

Parameters5/5

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

Schema description coverage is only 50%, but the description compensates thoroughly: it explains `limit` as requesting fewer characters, `offset` via next_offset paging instructions, `obligation_id` through the version/other_version discussion, and `compare_versions` as returning version_changes. It also explains derived response fields such as `paging`, `truncated`, `canonical_citation`, and `figures`, adding substantial meaning beyond the schema.

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 opens with a specific verb and resource: 'Return one obligation's verbatim regulator text with full provenance.' It then gives explicit answer-format instructions (quote exactly, include section citation, never paraphrase) and differentiates itself from find_in_section by scope. This makes the tool's purpose unmistakable and distinct from its siblings.

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?

The description explicitly tells the agent when find_in_section is the better alternative: 'For specific requirements in a long section, find_in_section is faster: it returns only the paragraphs containing your terms.' It also provides detailed paging and multi-version handling guidance so the agent knows exactly how to use this tool correctly across paginated results. This is explicit, actionable usage 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.

Resources