Your assistant can read your records, and only those
Four read tools let an agent list the record types your plan exposes, see their fields, query them and read one record. A field it may not see comes back empty with the reason.
Claude · Chiya Ghar café
describe_entity · inventory
query_records · inventory · quantity < 2
get_record · party · Gorkha Spice Traders
In short
list_entities, describe_entity, query_records and get_record let an agent read record types such as items, inventory, parties, coupons, reviews and conversations. Only fields on each type's allowlist are returned, filtered by plan and permission, and a withheld field comes back as null with a reason.
The problem it solves
To answer "which items are running low" an assistant needs your data. Handing it a database export gives it everything, including what it should never see.
How it works
3 steps, start to finish
-
1
See what is there
list_entities shows the record types this business exposes.
-
2
Learn the shape
describe_entity lists the fields the agent may read.
-
3
Query
query_records filters and reads many; get_record reads one.
In detail
What read your records does for you
-
29 record types
Items, variants, inventory, parties, coupons, reviews, conversations, shipments and more.
-
Allowlisted fields
Only the fields declared for agents are returned, never everything.
-
Withheld with a reason
A field you may not see is null, with why.
-
Read only
These four tools never write.
-
No. Each record type declares an allowlist of fields, and your plan and permissions filter it further.
-
No. They only read. Changes go through the typed actions, with confirmations where needed.
-
Orders have their own tools, list_orders and get_order.
Works together with
- List and read orders, preview a status change, then make it.
- An OAuth token per connection; the agent sees only the businesses and tools it is allowed.
- Create orders, collect payments, issue refunds, manage KOTs, adjust stock and record expenses.
- A count belongs to an outlet, so two shops never share one number.
Read your records · Free to start
Try read your records on your own business
Set up in a couple of minutes. Your catalogue, orders and books stay yours to export.
- Live in 2 minutes
- Free to start
- No credit card
