Skip to main content
Glama

Autocomplete a US address

lob_us_autocompletions_create
Read-onlyIdempotent

Autocomplete US addresses from a partial input for typeahead UX. Returns up to 10 suggestions based on address prefix, city, state, or zip code.

Instructions

Suggest completed US addresses from a partial input — useful for typeahead UX. Returns up to 10 suggestions.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
address_prefixYesPartial primary address line to autocomplete.
cityNo
stateNoTwo-letter US state code.
zip_codeNo
geo_ip_sortNoSort suggestions by proximity to the requesting IP.
extraNoAdditional Lob API parameters not enumerated above. Merged into the request body verbatim. See https://docs.lob.com for the full parameter list per resource.
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, idempotentHint=true, so the safety profile is clear. Description adds the return limit of 10 suggestions. This adds marginal value beyond annotations but does not contradict them.

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, no fluff, front-loaded with the primary action. Every sentence adds value: the first explains what it does and use case, the second specifies output limit. Ideal conciseness.

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

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With 6 parameters and no output schema, the description covers the main behavior and output count but lacks detail on how parameters like geo_ip_sort and extra affect results. Annotations supplement safety, but full operational context is missing.

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 67% (moderate), with 4 of 6 parameters described. The overall description does not add any additional meaning to parameters beyond what the schema provides. For the two parameters without schema descriptions (city, zip_code), the description also provides no guidance.

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?

Description clearly states it suggests completed US addresses from partial input for typeahead UX, and returns up to 10 suggestions. This distinguishes it from sibling tools like lob_us_verifications_create (verifies full addresses) and lob_addresses_list (lists existing addresses). The verb 'suggest' and resource 'US addresses' are specific.

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?

Explicitly mentions 'useful for typeahead UX' indicating when to use. However, it does not explicitly state when not to use or provide alternative tools. Given sibling tools are implicitly different, this is clear but not exhaustive.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/optimize-overseas/lob-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server