For agents
Machine-readable ways to read these docs and what the server expects of an agent.
Read the docs as Markdown
- Every docs page is also served as clean Markdown at its path plus
.md, for example/docs/quickstart.mdand/docs/tools/query_metrics.md. The index is/docs.md. /llms.txtlists every docs page in the llms.txt format./llms-full.txthas the full text of all pages in one file.- Both files and the tool reference are generated at build time from these pages and the live tool schemas. If a page and the server disagree, the server is right and the page is a bug: tell us at info@groundtruthdata.co.za.
How an agent should call the tools
- Call
describe_catalogfirst. It is free and lists metrics, geographies and limits. - Turn place names into ids with
resolve_location. Never guess anarea_id. If the status isambiguous, ask the user, or call again witharea_type. - Call
query_metricsorcompare_areas. Responses are capped; do not try to page through everything. - Quote the
citationsandcaveatswith every number. Useget_provenancefor the licence and method behind a metric.
Errors say what went wrong and how to fix it. See the Tool reference.