Skip to main content
Glama

C4C: Mortgage Industry Regulations

Get playbook kit

get_playbook_kit
Read-onlyIdempotent

Returns a playbook's rule kit. FNMA AI lender letter: the verbatim LL-2026-04, InfoSec Supplement and ECOA/Reg B/FCRA/AVM rows with citations, paginated; next_offset is the next page's offset, or null when the kit is complete. FHA/VA/USDA QC: the corpus registers each check area is grounded in. The kit block's fingerprint and dates identify its version. Playbook tools accept only ids and reference names, no document text; the user's P&Ps and loan files stay in their own chat.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesPlaybook id: one of fnma-ai-lender-letter, fha-underwriting-qc, va-loan-qc, usda-loan-qc.
offsetNoRow offset for the next page (the previous page's next_offset).

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNoThe playbook id.
kitNoThe kit's kind, source and version.
hintNoOn an error: the server's explanation.
noteNoA note on this result.
rowsNoKit rows: verbatim rule text with citations.
areasNoFor a corpus-register kit: its areas and registers.
errorNoPresent only on an error or refusal: not_found, ambiguous, unparsed, empty_terms, unknown_playbook, unknown_reference, offset_out_of_range, daily_capacity_reached.
noticeNoTerms notice: research use only, not legal advice.
offsetNoWhere this page starts.
resetsNoOn daily_capacity_reached: when capacity resets (00:00 UTC).
fallbackNoOn daily_capacity_reached: where the full corpus can be downloaded.
guidanceNoOn a refusal or empty search: the server's explanation.
valid_idsNoOn unknown_playbook: the valid ids.
rows_totalNoRows in the kit.
how_to_readNoFor a corpus-register kit: the server's reading note.
next_offsetNoThe next page's offset, or null when the kit is complete.
rows_returnedNoRows in this page.
search_familyNoFor a corpus-register kit: its search family.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "https://json-schema.org/draft/2020-12/schema",
      +  "additionalProperties": {},
      +  "description": "get_playbook_kit result.",
      +  "properties": {
      +    "areas": {
      +      "description": "For a corpus-register kit: its areas and registers."
      +    },
      +    "error": {
      +      "description": "Present only on an error or refusal: not_found, ambiguous, unparsed, empty_terms, unknown_playbook, unknown_reference, offset_out_of_range, daily_capacity_reached.",
      +      "type": "string"
      +    },
      +    "fallback": {
      +      "description": "On daily_capacity_reached: where the full corpus can be downloaded.",
      +      "type": "string"
      +    },
      +    "guidance": {
      +      "description": "On a refusal or empty search: the server's explanation.",
      +      "type": "string"
      +    },
      +    "hint": {
      +      "description": "On an error: the server's explanation.",
      +      "type": "string"
      +    },
      +    "how_to_read": {
      +      "description": "For a corpus-register kit: the server's reading note.",
      +      "type": "string"
      +    },
      +    "id": {
      +      "description": "The playbook id.",
      +      "type": "string"
      +    },
      +    "kit": {
      +      "description": "The kit's kind, source and version."
      +    },
      +    "next_offset": {
      +      "description": "The next page's offset, or null when the kit is complete.",
      +      "type": [
      +        "number",
      +        "null"
      +      ]
      +    },
      +    "note": {
      +      "description": "A note on this result.",
      +      "type": "string"
      +    },
      +    "notice": {
      +      "description": "Terms notice: research use only, not legal advice.",
      +      "type": "string"
      +    },
      +    "offset": {
      +      "description": "Where this page starts.",
      +      "type": "number"
      +    },
      +    "resets": {
      +      "description": "On daily_capacity_reached: when capacity resets (00:00 UTC).",
      +      "type": "string"
      +    },
      +    "rows": {
      +      "description": "Kit rows: verbatim rule text with citations."
      +    },
      +    "rows_returned": {
      +      "description": "Rows in this page.",
      +      "type": "number"
      +    },
      +    "rows_total": {
      +      "description": "Rows in the kit.",
      +      "type": "number"
      +    },
      +    "search_family": {
      +      "description": "For a corpus-register kit: its search family."
      +    },
      +    "valid_ids": {
      +      "description": "On unknown_playbook: the valid ids.",
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    }
      +  },
      +  "type": "object"
      +}
  2. First observed

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already establish read-only/idempotent/non-destructive safety, but the description adds real behavioral context: pagination via next_offset (null when complete), version identity through the kit block's fingerprint and dates, and a privacy boundary that inputs are ids/reference names only with user documents staying in their own chat.

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 the core purpose and pagination behavior; each sentence carries content (contents, paging, versioning, input constraints). The middle sentences are dense with domain jargon, which slightly taxes readability but nothing is wasted.

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?

Given an output schema exists, the description needn't restate return values, yet it voluntarily covers pagination semantics, version identification, per-playbook content, and input constraints. It is complete enough for correct invocation, with only the sibling-routing guidance left thin.

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 id and offset are already documented, establishing the baseline. The description adds meaning to the offset parameter by explaining that next_offset feeds the next page, but it does not add format or syntax beyond the schema.

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?

Opens with a specific verb+resource ('Returns a playbook's rule kit') and then details the actual contents per playbook family (verbatim LL-2026-04, InfoSec Supplement, ECOA/Reg B/FCRA/AVM rows; corpus registers for FHA/VA/USDA). This lets an agent know what it will receive, though it never explicitly contrasts itself with siblings like get_playbook_reference or find_in_section.

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?

Usage is only implied. The line 'Playbook tools accept only ids and reference names, no document text' sets a boundary but does not say when to choose this tool over get_playbook_reference, get_reg, or get_obligation. No exclusions or 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.