Skip to main content
Glama

Check broadband availability

check_availability
Read-onlyIdempotent

Start with {address}; continue only with a returned candidate_id and requested unit, {lookup_id} to poll, or the current question_set_id and answers. FCC findings are area-level evidence. Select only returned executable offer_id values.

Input Schema

NameRequiredDescriptionDefault
unitNo
addressNo
answersNo
lookup_idNo
candidate_idNo
question_set_idNo

Output Schema

NameRequiredDescriptionDefault
errorNo
statusYes
messageNo
sourcesNo
revisionNo
warningsNo
lookup_idNo
providersNo
questionsNo
candidatesNo
expires_atNo
next_actionNo
required_fieldNo
schema_versionYes
question_set_idNo
clarification_typeNo
normalized_addressNo
retry_after_secondsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / $defs / ErrorDetail / properties / retry_after_seconds / anyOf
      Previous value: -[
      -  {
      -    "maximum": 300,
      -    "minimum": 1,
      -    "type": "integer"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "maximum": 86400,
      +    "minimum": 1,
      +    "type": "integer"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
  2. Changed72 schema fields changed
    • removedInput schema / properties / address / description
      Removed value: -"An imperfect natural-language U.S. service address."
    • addedInput schema / properties / answers
      Added value: +{
      +  "anyOf": [
      +    {
      +      "additionalProperties": true,
      +      "type": "object"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Answers"
      +}
    • removedInput schema / properties / candidateId
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "maxLength": 2048,
      -      "minLength": 1,
      -      "type": "string"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "default": null,
      -  "description": "Opaque ID returned by a previous clarification result.",
      -  "title": "Candidateid"
      -}
    • addedInput schema / properties / candidate_id
      Added value: +{
      +  "anyOf": [
      +    {
      +      "maxLength": 2048,
      +      "minLength": 1,
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Candidate Id"
      +}
    • removedInput schema / properties / lookupId
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "maxLength": 128,
      -      "minLength": 1,
      -      "type": "string"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "default": null,
      -  "description": "Opaque ID returned by a previous processing result.",
      -  "title": "Lookupid"
      -}
    • addedInput schema / properties / lookup_id
      Added value: +{
      +  "anyOf": [
      +    {
      +      "maxLength": 256,
      +      "minLength": 1,
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Lookup Id"
      +}
    • addedInput schema / properties / question_set_id
      Added value: +{
      +  "anyOf": [
      +    {
      +      "maxLength": 256,
      +      "minLength": 1,
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Question Set Id"
      +}
    • removedInput schema / properties / unit / description
      Removed value: -"Apartment, suite, or unit requested by a unit clarification."
    • removedOutput schema / $defs / Candidate / properties / candidateId
      Removed value: -{
      -  "maxLength": 2048,
      -  "minLength": 1,
      -  "title": "Candidateid",
      -  "type": "string"
      -}
    • addedOutput schema / $defs / Candidate / properties / candidate_id
      Added value: +{
      +  "maxLength": 2048,
      +  "minLength": 1,
      +  "title": "Candidate Id",
      +  "type": "string"
      +}
    • removedOutput schema / $defs / Candidate / properties / requiresUnit
      Removed value: -{
      -  "title": "Requiresunit",
      -  "type": "boolean"
      -}
    • addedOutput schema / $defs / Candidate / properties / requires_unit
      Added value: +{
      +  "title": "Requires Unit",
      +  "type": "boolean"
      +}
    • changedOutput schema / $defs / Candidate / required
      Previous value: -[
      -  "candidateId",
      -  "display",
      -  "requiresUnit"
      -]New value: +[
      +  "candidate_id",
      +  "display",
      +  "requires_unit"
      +]
    • addedOutput schema / $defs / ContractTerms
      Added value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "months": {
      +      "anyOf": [
      +        {
      +          "minimum": 0,
      +          "type": "integer"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "default": null,
      +      "title": "Months"
      +    },
      +    "required": {
      +      "anyOf": [
      +        {
      +          "type": "boolean"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "default": null,
      +      "title": "Required"
      +    }
      +  },
      +  "title": "ContractTerms",
      +  "type": "object"
      +}
    • removedOutput schema / $defs / Coverage
      Removed value: -{
      -  "additionalProperties": false,
      -  "properties": {
      -    "checkedAt": {
      -      "format": "date-time",
      -      "title": "Checkedat",
      -      "type": "string"
      -    },
      -    "dataAsOf": {
      -      "anyOf": [
      -        {
      -          "format": "date-time",
      -          "type": "string"
      -        },
      -        {
      -          "type": "null"
      -        }
      -      ],
      -      "title": "Dataasof"
      -    },
      -    "source": {
      -      "enum": [
      -        "one_source",
      -        "fcc"
      -      ],
      -      "title": "Source",
      -      "type": "string"
      -    }
      -  },
      -  "required": [
      -    "source",
      -    "checkedAt",
      -    "dataAsOf"
      -  ],
      -  "title": "Coverage",
      -  "type": "object"
      -}
    • changedOutput schema / $defs / ErrorDetail / properties / code / enum
      Previous value: -[
      -  "invalid_request",
      -  "invalid_address",
      -  "invalid_candidate",
      -  "lookup_not_found",
      -  "lookup_timeout",
      -  "upstream_unavailable",
      -  "rate_limited"
      -]New value: +[
      +  "invalid_request",
      +  "invalid_address",
      +  "invalid_answer",
      +  "not_found",
      +  "expired",
      +  "offer_changed",
      +  "offer_unavailable",
      +  "validation_required",
      +  "confirmation_required",
      +  "idempotency_conflict",
      +  "duplicate_order",
      +  "rate_limited",
      +  "temporarily_unavailable"
      +]
    • addedOutput schema / $defs / ErrorDetail / properties / correlation_id
      Added value: +{
      +  "anyOf": [
      +    {
      +      "maxLength": 128,
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Correlation Id"
      +}
    • addedOutput schema / $defs / ErrorDetail / properties / field_errors
      Added value: +{
      +  "anyOf": [
      +    {
      +      "additionalProperties": {
      +        "type": "string"
      +      },
      +      "type": "object"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Field Errors"
      +}
    • removedOutput schema / $defs / ErrorDetail / properties / nextAction
      Removed value: -{
      -  "maxLength": 500,
      -  "minLength": 1,
      -  "title": "Nextaction",
      -  "type": "string"
      -}
    • addedOutput schema / $defs / ErrorDetail / properties / next_action
      Added value: +{
      +  "maxLength": 500,
      +  "minLength": 1,
      +  "title": "Next Action",
      +  "type": "string"
      +}
    • addedOutput schema / $defs / ErrorDetail / properties / retry_after_seconds
      Added value: +{
      +  "anyOf": [
      +    {
      +      "maximum": 300,
      +      "minimum": 1,
      +      "type": "integer"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Retry After Seconds"
      +}
    • changedOutput schema / $defs / ErrorDetail / required
      Previous value: -[
      -  "code",
      -  "message",
      -  "retryable",
      -  "nextAction"
      -]New value: +[
      +  "code",
      +  "message",
      +  "retryable",
      +  "next_action"
      +]
    • addedOutput schema / $defs / FccMatch
      Added value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "data_as_of": {
      +      "anyOf": [
      +        {
      +          "format": "date-time",
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "default": null,
      +      "title": "Data As Of"
      +    },
      +    "granularity": {
      +      "enum": [
      +        "census_block",
      +        "census_tract"
      +      ],
      +      "title": "Granularity",
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "granularity"
      +  ],
      +  "title": "FccMatch",
      +  "type": "object"
      +}
    • addedOutput schema / $defs / FeeFacts
      Added value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "activation_cents": {
      +      "anyOf": [
      +        {
      +          "minimum": 0,
      +          "type": "integer"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "default": null,
      +      "title": "Activation Cents"
      +    },
      +    "currency": {
      +      "pattern": "^[A-Z]{3}$",
      +      "title": "Currency",
      +      "type": "string"
      +    },
      +    "professional_installation_cents": {
      +      "anyOf": [
      +        {
      +          "minimum": 0,
      +          "type": "integer"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "default": null,
      +      "title": "Professional Installation Cents"
      +    },
      +    "recurring_equipment_cents": {
      +      "anyOf": [
      +        {
      +          "minimum": 0,
      +          "type": "integer"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "default": null,
      +      "title": "Recurring Equipment Cents"
      +    },
      +    "self_installation_cents": {
      +      "anyOf": [
      +        {
      +          "minimum": 0,
      +          "type": "integer"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "default": null,
      +      "title": "Self Installation Cents"
      +    }
      +  },
      +  "required": [
      +    "currency"
      +  ],
      +  "title": "FeeFacts",
      +  "type": "object"
      +}
    • removedOutput schema / $defs / Fees
      Removed value: -{
      -  "additionalProperties": false,
      -  "properties": {
      -    "activationCents": {
      -      "anyOf": [
      -        {
      -          "minimum": 0,
      -          "type": "integer"
      -        },
      -        {
      -          "type": "null"
      -        }
      -      ],
      -      "title": "Activationcents"
      -    },
      -    "currency": {
      -      "const": "USD",
      -      "title": "Currency",
      -      "type": "string"
      -    },
      -    "professionalInstallationCents": {
      -      "anyOf": [
      -        {
      -          "minimum": 0,
      -          "type": "integer"
      -        },
      -        {
      -          "type": "null"
      -        }
      -      ],
      -      "title": "Professionalinstallationcents"
      -    },
      -    "selfInstallationCents": {
      -      "anyOf": [
      -        {
      -          "minimum": 0,
      -          "type": "integer"
      -        },
      -        {
      -          "type": "null"
      -        }
      -      ],
      -      "title": "Selfinstallationcents"
      -    }
      -  },
      -  "required": [
      -    "selfInstallationCents",
      -    "professionalInstallationCents",
      -    "activationCents",
      -    "currency"
      -  ],
      -  "title": "Fees",
      -  "type": "object"
      -}
    • addedOutput schema / $defs / InformationalPlan
      Added value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "conditions": {
      +      "items": {
      +        "type": "string"
      +      },
      +      "maxItems": 50,
      +      "title": "Conditions",
      +      "type": "array"
      +    },
      +    "contract_terms": {
      +      "$ref": "#/$defs/ContractTerms"
      +    },
      +    "data_limit": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "integer"
      +        },
      +        {
      +          "type": "number"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "default": null,
      +      "title": "Data Limit"
      +    },
      +    "download_mbps": {
      +      "anyOf": [
      +        {
      +          "minimum": 0,
      +          "type": "number"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "default": null,
      +      "title": "Download Mbps"
      +    },
      +    "fees": {
      +      "$ref": "#/$defs/FeeFacts"
      +    },
      +    "name": {
      +      "maxLength": 300,
      +      "minLength": 1,
      +      "title": "Name",
      +      "type": "string"
      +    },
      +    "pricing": {
      +      "$ref": "#/$defs/MoneyFacts"
      +    },
      +    "technology": {
      +      "anyOf": [
      +        {
      +          "maxLength": 100,
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "default": null,
      +      "title": "Technology"
      +    },
      +    "upload_mbps": {
      +      "anyOf": [
      +        {
      +          "minimum": 0,
      +          "type": "number"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "default": null,
      +      "title": "Upload Mbps"
      +    }
      +  },
      +  "required": [
      +    "name",
      +    "pricing",
      +    "fees",
      +    "contract_terms"
      +  ],
      +  "title": "InformationalPlan",
      +  "type": "object"
      +}
    • addedOutput schema / $defs / MoneyFacts
      Added value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "currency": {
      +      "pattern": "^[A-Z]{3}$",
      +      "title": "Currency",
      +      "type": "string"
      +    },
      +    "intro_months": {
      +      "anyOf": [
      +        {
      +          "minimum": 0,
      +          "type": "integer"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "default": null,
      +      "title": "Intro Months"
      +    },
      +    "monthly_cents": {
      +      "anyOf": [
      +        {
      +          "minimum": 0,
      +          "type": "integer"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "default": null,
      +      "title": "Monthly Cents"
      +    },
      +    "regular_monthly_cents": {
      +      "anyOf": [
      +        {
      +          "minimum": 0,
      +          "type": "integer"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "default": null,
      +      "title": "Regular Monthly Cents"
      +    }
      +  },
      +  "required": [
      +    "currency"
      +  ],
      +  "title": "MoneyFacts",
      +  "type": "object"
      +}
    • removedOutput schema / $defs / NormalizedAddress / properties / postalCode
      Removed value: -{
      -  "pattern": "^\\d{5}(?:-\\d{4})?$",
      -  "title": "Postalcode",
      -  "type": "string"
      -}
    • addedOutput schema / $defs / NormalizedAddress / properties / postal_code
      Added value: +{
      +  "pattern": "^\\d{5}(?:-\\d{4})?$",
      +  "title": "Postal Code",
      +  "type": "string"
      +}
    • removedOutput schema / $defs / NormalizedAddress / properties / streetLine
      Removed value: -{
      -  "maxLength": 300,
      -  "minLength": 1,
      -  "title": "Streetline",
      -  "type": "string"
      -}
    • addedOutput schema / $defs / NormalizedAddress / properties / street_line
      Added value: +{
      +  "maxLength": 300,
      +  "minLength": 1,
      +  "title": "Street Line",
      +  "type": "string"
      +}
    • addedOutput schema / $defs / NormalizedAddress / properties / unit / default
      Added value: +null
    • changedOutput schema / $defs / NormalizedAddress / required
      Previous value: -[
      -  "display",
      -  "streetLine",
      -  "unit",
      -  "city",
      -  "state",
      -  "postalCode"
      -]New value: +[
      +  "display",
      +  "street_line",
      +  "city",
      +  "state",
      +  "postal_code"
      +]
    • addedOutput schema / $defs / Offer
      Added value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "conditions": {
      +      "items": {
      +        "type": "string"
      +      },
      +      "maxItems": 50,
      +      "title": "Conditions",
      +      "type": "array"
      +    },
      +    "contract_terms": {
      +      "$ref": "#/$defs/ContractTerms"
      +    },
      +    "data_limit": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "integer"
      +        },
      +        {
      +          "type": "number"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "default": null,
      +      "title": "Data Limit"
      +    },
      +    "download_mbps": {
      +      "anyOf": [
      +        {
      +          "minimum": 0,
      +          "type": "number"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "default": null,
      +      "title": "Download Mbps"
      +    },
      +    "expires_at": {
      +      "format": "date-time",
      +      "title": "Expires At",
      +      "type": "string"
      +    },
      +    "fees": {
      +      "$ref": "#/$defs/FeeFacts"
      +    },
      +    "name": {
      +      "maxLength": 300,
      +      "minLength": 1,
      +      "title": "Name",
      +      "type": "string"
      +    },
      +    "offer_id": {
      +      "maxLength": 256,
      +      "minLength": 1,
      +      "title": "Offer Id",
      +      "type": "string"
      +    },
      +    "orderable_through_hum": {
      +      "const": true,
      +      "title": "Orderable Through Hum",
      +      "type": "boolean"
      +    },
      +    "pricing": {
      +      "$ref": "#/$defs/MoneyFacts"
      +    },
      +    "provider_id": {
      +      "maxLength": 256,
      +      "minLength": 1,
      +      "title": "Provider Id",
      +      "type": "string"
      +    },
      +    "qualification_revision": {
      +      "minimum": 1,
      +      "title": "Qualification Revision",
      +      "type": "integer"
      +    },
      +    "qualified_at": {
      +      "format": "date-time",
      +      "title": "Qualified At",
      +      "type": "string"
      +    },
      +    "technology": {
      +      "anyOf": [
      +        {
      +          "maxLength": 100,
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "default": null,
      +      "title": "Technology"
      +    },
      +    "upload_mbps": {
      +      "anyOf": [
      +        {
      +          "minimum": 0,
      +          "type": "number"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "default": null,
      +      "title": "Upload Mbps"
      +    }
      +  },
      +  "required": [
      +    "name",
      +    "pricing",
      +    "fees",
      +    "contract_terms",
      +    "offer_id",
      +    "provider_id",
      +    "qualification_revision",
      +    "qualified_at",
      +    "expires_at",
      +    "orderable_through_hum"
      +  ],
      +  "title": "Offer",
      +  "type": "object"
      +}
    • removedOutput schema / $defs / Plan
      Removed value: -{
      -  "additionalProperties": false,
      -  "properties": {
      -    "contractMonths": {
      -      "anyOf": [
      -        {
      -          "minimum": 0,
      -          "type": "integer"
      -        },
      -        {
      -          "type": "null"
      -        }
      -      ],
      -      "title": "Contractmonths"
      -    },
      -    "contractRequired": {
      -      "anyOf": [
      -        {
      -          "type": "boolean"
      -        },
      -        {
      -          "type": "null"
      -        }
      -      ],
      -      "title": "Contractrequired"
      -    },
      -    "dataLimit": {
      -      "anyOf": [
      -        {
      -          "type": "string"
      -        },
      -        {
      -          "type": "integer"
      -        },
      -        {
      -          "type": "number"
      -        },
      -        {
      -          "type": "null"
      -        }
      -      ],
      -      "title": "Datalimit"
      -    },
      -    "downloadMbps": {
      -      "anyOf": [
      -        {
      -          "minimum": 0,
      -          "type": "number"
      -        },
      -        {
      -          "type": "null"
      -        }
      -      ],
      -      "title": "Downloadmbps"
      -    },
      -    "fees": {
      -      "$ref": "#/$defs/Fees"
      -    },
      -    "name": {
      -      "maxLength": 300,
      -      "minLength": 1,
      -      "title": "Name",
      -      "type": "string"
      -    },
      -    "pricing": {
      -      "$ref": "#/$defs/Pricing"
      -    },
      -    "promotion": {
      -      "anyOf": [
      -        {
      -          "maxLength": 2000,
      -          "type": "string"
      -        },
      -        {
      -          "type": "null"
      -        }
      -      ],
      -      "title": "Promotion"
      -    },
      -    "technology": {
      -      "anyOf": [
      -        {
      -          "maxLength": 100,
      -          "type": "string"
      -        },
      -        {
      -          "type": "null"
      -        }
      -      ],
      -      "title": "Technology"
      -    },
      -    "uploadMbps": {
      -      "anyOf": [
      -        {
      -          "minimum": 0,
      -          "type": "number"
      -        },
      -        {
      -          "type": "null"
      -        }
      -      ],
      -      "title": "Uploadmbps"
      -    }
      -  },
      -  "required": [
      -    "name",
      -    "technology",
      -    "downloadMbps",
      -    "uploadMbps",
      -    "dataLimit",
      -    "contractRequired",
      -    "contractMonths",
      -    "pricing",
      -    "fees",
      -    "promotion"
      -  ],
      -  "title": "Plan",
      -  "type": "object"
      -}
    • removedOutput schema / $defs / Pricing
      Removed value: -{
      -  "additionalProperties": false,
      -  "properties": {
      -    "currency": {
      -      "const": "USD",
      -      "title": "Currency",
      -      "type": "string"
      -    },
      -    "introMonths": {
      -      "anyOf": [
      -        {
      -          "minimum": 0,
      -          "type": "integer"
      -        },
      -        {
      -          "type": "null"
      -        }
      -      ],
      -      "title": "Intromonths"
      -    },
      -    "monthlyCents": {
      -      "anyOf": [
      -        {
      -          "minimum": 0,
      -          "type": "integer"
      -        },
      -        {
      -          "type": "null"
      -        }
      -      ],
      -      "title": "Monthlycents"
      -    },
      -    "regularMonthlyCents": {
      -      "anyOf": [
      -        {
      -          "minimum": 0,
      -          "type": "integer"
      -        },
      -        {
      -          "type": "null"
      -        }
      -      ],
      -      "title": "Regularmonthlycents"
      -    }
      -  },
      -  "required": [
      -    "monthlyCents",
      -    "regularMonthlyCents",
      -    "introMonths",
      -    "currency"
      -  ],
      -  "title": "Pricing",
      -  "type": "object"
      -}
    • addedOutput schema / $defs / Provider / properties / catalog_plans
      Added value: +{
      +  "items": {
      +    "$ref": "#/$defs/InformationalPlan"
      +  },
      +  "maxItems": 500,
      +  "title": "Catalog Plans",
      +  "type": "array"
      +}
    • addedOutput schema / $defs / Provider / properties / fcc_match
      Added value: +{
      +  "anyOf": [
      +    {
      +      "$ref": "#/$defs/FccMatch"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null
      +}
    • removedOutput schema / $defs / Provider / properties / logoUrl
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "maxLength": 2048,
      -      "type": "string"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "title": "Logourl"
      -}
    • addedOutput schema / $defs / Provider / properties / offers
      Added value: +{
      +  "items": {
      +    "$ref": "#/$defs/Offer"
      +  },
      +  "maxItems": 500,
      +  "title": "Offers",
      +  "type": "array"
      +}
    • addedOutput schema / $defs / Provider / properties / orderable_through_hum
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "boolean"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Orderable Through Hum"
      +}
    • removedOutput schema / $defs / Provider / properties / plans
      Removed value: -{
      -  "items": {
      -    "$ref": "#/$defs/Plan"
      -  },
      -  "maxItems": 500,
      -  "title": "Plans",
      -  "type": "array"
      -}
    • addedOutput schema / $defs / Provider / properties / provenance
      Added value: +{
      +  "items": {
      +    "enum": [
      +      "fcc",
      +      "live_provider_check"
      +    ],
      +    "type": "string"
      +  },
      +  "maxItems": 2,
      +  "minItems": 1,
      +  "title": "Provenance",
      +  "type": "array"
      +}
    • addedOutput schema / $defs / Provider / properties / provider_id
      Added value: +{
      +  "maxLength": 256,
      +  "minLength": 1,
      +  "title": "Provider Id",
      +  "type": "string"
      +}
    • addedOutput schema / $defs / Provider / properties / qualification_status
      Added value: +{
      +  "enum": [
      +    "not_checked",
      +    "checking",
      +    "needs_information",
      +    "qualified",
      +    "not_qualified",
      +    "failed"
      +  ],
      +  "title": "Qualification Status",
      +  "type": "string"
      +}
    • removedOutput schema / $defs / Provider / properties / technologies
      Removed value: -{
      -  "items": {
      -    "type": "string"
      -  },
      -  "maxItems": 50,
      -  "title": "Technologies",
      -  "type": "array"
      -}
    • changedOutput schema / $defs / Provider / required
      Previous value: -[
      -  "name",
      -  "logoUrl",
      -  "technologies",
      -  "plans"
      -]New value: +[
      +  "provider_id",
      +  "name",
      +  "provenance",
      +  "qualification_status"
      +]
    • addedOutput schema / $defs / Question
      Added value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "choices": {
      +      "anyOf": [
      +        {
      +          "items": {
      +            "type": "string"
      +          },
      +          "maxItems": 100,
      +          "type": "array"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "default": null,
      +      "title": "Choices"
      +    },
      +    "prompt": {
      +      "maxLength": 500,
      +      "minLength": 1,
      +      "title": "Prompt",
      +      "type": "string"
      +    },
      +    "question_id": {
      +      "maxLength": 256,
      +      "minLength": 1,
      +      "title": "Question Id",
      +      "type": "string"
      +    },
      +    "required": {
      +      "title": "Required",
      +      "type": "boolean"
      +    },
      +    "sensitivity": {
      +      "enum": [
      +        "none",
      +        "personal",
      +        "sensitive"
      +      ],
      +      "title": "Sensitivity",
      +      "type": "string"
      +    },
      +    "type": {
      +      "enum": [
      +        "string",
      +        "boolean",
      +        "single_choice",
      +        "date"
      +      ],
      +      "title": "Type",
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "question_id",
      +    "prompt",
      +    "type",
      +    "required",
      +    "sensitivity"
      +  ],
      +  "title": "Question",
      +  "type": "object"
      +}
    • addedOutput schema / $defs / SourceState
      Added value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "checked_at": {
      +      "anyOf": [
      +        {
      +          "format": "date-time",
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "default": null,
      +      "title": "Checked At"
      +    },
      +    "data_as_of": {
      +      "anyOf": [
      +        {
      +          "format": "date-time",
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "default": null,
      +      "title": "Data As Of"
      +    },
      +    "error": {
      +      "anyOf": [
      +        {
      +          "$ref": "#/$defs/ErrorDetail"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "default": null
      +    },
      +    "status": {
      +      "enum": [
      +        "checking",
      +        "needs_information",
      +        "complete",
      +        "failed",
      +        "timed_out"
      +      ],
      +      "title": "Status",
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "status"
      +  ],
      +  "title": "SourceState",
      +  "type": "object"
      +}
    • addedOutput schema / $defs / Sources
      Added value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "fcc": {
      +      "$ref": "#/$defs/SourceState"
      +    },
      +    "live_provider_check": {
      +      "$ref": "#/$defs/SourceState"
      +    }
      +  },
      +  "required": [
      +    "fcc",
      +    "live_provider_check"
      +  ],
      +  "title": "Sources",
      +  "type": "object"
      +}
    • removedOutput schema / description
      Removed value: -"Object-root output schema with status-specific runtime validation.\n\nOlder MCP peers require an object at the root of ``outputSchema``. The status is still a\ndiscriminator: every returned payload is validated against ``AvailabilityResult``."
    • removedOutput schema / properties / clarificationType
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "enum": [
      -        "candidate_selection",
      -        "unit_required"
      -      ],
      -      "type": "string"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "default": null,
      -  "title": "Clarificationtype"
      -}
    • addedOutput schema / properties / clarification_type
      Added value: +{
      +  "anyOf": [
      +    {
      +      "enum": [
      +        "candidate_selection",
      +        "unit_required"
      +      ],
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Clarification Type"
      +}
    • removedOutput schema / properties / coverage
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "$ref": "#/$defs/Coverage"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "default": null
      -}
    • addedOutput schema / properties / expires_at
      Added value: +{
      +  "anyOf": [
      +    {
      +      "format": "date-time",
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Expires At"
      +}
    • removedOutput schema / properties / lookupId
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "maxLength": 128,
      -      "type": "string"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "default": null,
      -  "title": "Lookupid"
      -}
    • addedOutput schema / properties / lookup_id
      Added value: +{
      +  "anyOf": [
      +    {
      +      "maxLength": 256,
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Lookup Id"
      +}
    • addedOutput schema / properties / next_action
      Added value: +{
      +  "anyOf": [
      +    {
      +      "maxLength": 1000,
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Next Action"
      +}
    • removedOutput schema / properties / normalizedAddress
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "$ref": "#/$defs/NormalizedAddress"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "default": null
      -}
    • addedOutput schema / properties / normalized_address
      Added value: +{
      +  "anyOf": [
      +    {
      +      "$ref": "#/$defs/NormalizedAddress"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null
      +}
    • addedOutput schema / properties / question_set_id
      Added value: +{
      +  "anyOf": [
      +    {
      +      "maxLength": 256,
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Question Set Id"
      +}
    • addedOutput schema / properties / questions
      Added value: +{
      +  "items": {
      +    "$ref": "#/$defs/Question"
      +  },
      +  "maxItems": 100,
      +  "title": "Questions",
      +  "type": "array"
      +}
    • removedOutput schema / properties / requiredField
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "const": "unit",
      -      "type": "string"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "default": null,
      -  "title": "Requiredfield"
      -}
    • addedOutput schema / properties / required_field
      Added value: +{
      +  "anyOf": [
      +    {
      +      "const": "unit",
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Required Field"
      +}
    • removedOutput schema / properties / retryAfterSeconds
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "maximum": 300,
      -      "minimum": 1,
      -      "type": "integer"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "default": null,
      -  "title": "Retryafterseconds"
      -}
    • addedOutput schema / properties / retry_after_seconds
      Added value: +{
      +  "anyOf": [
      +    {
      +      "maximum": 300,
      +      "minimum": 1,
      +      "type": "integer"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Retry After Seconds"
      +}
    • addedOutput schema / properties / revision
      Added value: +{
      +  "anyOf": [
      +    {
      +      "minimum": 1,
      +      "type": "integer"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Revision"
      +}
    • removedOutput schema / properties / schemaVersion
      Removed value: -{
      -  "const": 3,
      -  "title": "Schemaversion",
      -  "type": "integer"
      -}
    • addedOutput schema / properties / schema_version
      Added value: +{
      +  "const": 4,
      +  "title": "Schema Version",
      +  "type": "integer"
      +}
    • addedOutput schema / properties / sources
      Added value: +{
      +  "anyOf": [
      +    {
      +      "$ref": "#/$defs/Sources"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null
      +}
    • changedOutput schema / properties / status / enum
      Previous value: -[
      -  "available",
      -  "no_service",
      -  "needs_clarification",
      -  "processing",
      -  "error"
      -]New value: +[
      +  "checking",
      +  "needs_information",
      +  "complete",
      +  "failed",
      +  "error"
      +]
    • changedOutput schema / required
      Previous value: -[
      -  "schemaVersion",
      -  "status",
      -  "warnings"
      -]New value: +[
      +  "schema_version",
      +  "status"
      +]
  3. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare read-only, open-world, idempotent, and non-destructive behavior. The description adds meaningful context beyond annotations: FCC findings are area-level evidence (not exact), and only returned executable offer_id values should be selected, plus it implies polling via lookup_id. It does not cover error modes or rate limits, but the added caveats are valuable.

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 zero waste, front-loaded with the starting action. Every clause provides essential workflow or selection guidance without redundancy.

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 the output schema covers return values and annotations cover safety, the description supplies the operational sequence and key caveats (area-level evidence, executable offer_id). It lacks explicit definitions for some IDs and does not explain how results integrate with sibling order tools, but it is largely complete for correct invocation.

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 description coverage is 0%, so the description must compensate. It mentions all six parameters and explains their roles in the workflow (address to start, candidate_id+unit to continue, lookup_id to poll, question_set_id+answers for current questions). It leaves some ambiguity about what each ID represents and the format of answers, but it provides substantial usage meaning beyond the bare 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?

The title 'Check broadband availability' clearly states the purpose, and the description adds specifics about FCC findings and executable offers. However, the description itself does not restate the purpose in a standalone sentence; it assumes the title and jumps directly into workflow instructions. It distinguishes from order-management siblings by focusing on availability and offer selection.

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

Usage Guidelines4/5

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

The description explicitly says 'Start with {address}; continue only with...' and details the conditional paths for candidate_id/unit, lookup_id polling, and question_set_id/answers. This gives clear invocation context, though it does not name alternatives or explicitly say when not to use the tool.

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