`shovels_address_search`

Pack: shovels · Endpoint: https://gateway.pipeworx.io/shovels/mcp

Resolve a US address to Shovels records, each carrying a geo_id — the geolocation ID you pass to shovels_permits_search / shovels_contractors_search to scope those queries. Results are ordered by relevance in USPS notation. Example: shovels_address_search({ q: “1600 Pennsylvania Ave NW, Washington DC”, _apiKey: “your-key” })

Parameters

Name	Type	Required	Description
`q`	string	yes	The text to search for in address fields, e.g. “123 Main St, Austin TX” or a partial address.
`size`	number	no	Number of results to return (1-100, default 50).
`cursor`	string	no	Pagination cursor from a previous response `next_cursor`.
`_apiKey`	string	yes	Shovels API key (X-API-Key). Sign up at ${SIGNUP_URL}

Example call

Arguments

{
  "q": "1600 Pennsylvania Ave NW, Washington DC",
  "_apiKey": "your-shovels-api-key"
}

curl

curl -X POST https://gateway.pipeworx.io/shovels/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"shovels_address_search","arguments":{"q":"1600 Pennsylvania Ave NW, Washington DC","_apiKey":"your-shovels-api-key"}}}'

TypeScript (@pipeworx/sdk)

import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();

const result = await pipeworx.call('shovels_address_search', {
  "q": "1600 Pennsylvania Ave NW, Washington DC",
  "_apiKey": "your-shovels-api-key"
});

More examples

{
  "q": "123 Main St, Austin TX",
  "size": 10,
  "_apiKey": "your-shovels-api-key"
}

Connect

Add this to your MCP client config, or use one-click install buttons:

{
  "mcpServers": {
    "shovels": {
      "url": "https://gateway.pipeworx.io/shovels/mcp"
    }
  }
}

See Getting Started for client-specific install steps.

shovels_address_search