The tool surface

Tools

hello

Greets a name. It proves the server is reachable and that your token lets you call a tool.

ping

Reports whether the server can reach the records behind it, and which client and person are calling. It reads no tables.

ping takes no arguments.

{
  "name": "ping",
  "arguments": {}
}

What comes back, field by field.

server

This server, named.

database

Whether the records behind the server can be reached, or the reason the connection failed.

schema_name

Which set of records the connection is pointed at.

caller

The OAuth client that called, or anonymous when the request carried no token.

subject

The person the token was issued for, kept distinct from the client that asked on their behalf. An action taken through an agent is still attributable to whoever approved it.

token_use

user when a person consented, machine otherwise.

scopes

The scopes on the caller's token.

Asking over HTTP

The HTTP API takes an API key in a header and needs no OAuth dance, which is enough for an agent that can make a request:

curl -X GET 'http://localhost:8000/place?as_of=2026-09-13&address=100+Main+St&point=35.225%2C-78.642' \
  -H 'X-API-Key: $PLACESTACK_API_KEY'

Point a model at /docs/openapi.json for the full contract. Every answer carries a coverage block for the jurisdiction and layer it came from.

Make the first call →