Tool reference
Every tool exposed by the VayaCore MCP server — input schema, output shape, and an example prompt for each. See the developer landing for install and the system-prompt snippet.
VayaPin identity
resolve_pin
Get the full delivery payload for a VayaPin ID — GPS coordinates, structured street address, contact info, photos, delivery hours, and preferred drop-off instructions.
| Field | Type | Notes | |
|---|---|---|---|
vayapin_id | string | required | COUNTRY:NAME, both upper-case, e.g. BB:TAPAS887 (pattern ^[A-Z]{2}:[A-Z0-9]+$). |
{
"data_set": {
"pin_data_location": { "latitude": 13.0975, "longitude": -59.6105 },
"address": { "street": "...", "city": "..." },
"contact": { }, "photos": [ ], "delivery_hours": "..."
}
}preview_pin
Suggest available VayaPin names for a user based on their name. Call before confirm_pin.
| Field | Type | Notes | |
|---|---|---|---|
name | string | required | Proposed name to check (1–64 chars). |
country_code | string | required | ISO-3166-1 alpha-2, upper-case, e.g. BB. |
{ "requested_name": "TAPAS", "is_available": false,
"suggestions": ["TAPAS887", "TAPASBAR", "TAPAS246"] }confirm_pin
Reserve a VayaPin name and send the signup link to the user via WhatsApp, SMS, or email. Returns a reservation that expires in 24h. The link goes to the user, never back to the agent.
| Field | Type | Notes | |
|---|---|---|---|
name | string | required | Upper-case letters and digits (^[A-Z0-9]+$). |
country_code | string | required | ISO-3166-1 alpha-2. A name is unique per country. |
identifier | string | required | Phone in E.164 (sms/whatsapp) or email address. |
channel | enum | required | whatsapp · sms · email |
callback_url | string | required | HTTPS URL for the pin_created webhook after signup. |
{ "reservation_id": "...", "expires_at": "2026-06-21T12:00:00Z" }Google Maps
geocode
Convert a text address to GPS coordinates (latitude/longitude). Wraps the Google Geocoding API using the brand's own Google Maps key.
| Field | Type | Notes | |
|---|---|---|---|
address | string | required | Address or place name, e.g. 1600 Amphitheatre Pkwy, Mountain View, CA. |
country_code | string | optional | ISO 3166-1 region bias, e.g. us, bb. |
{ "results": [{ "geometry": { "location": { "lat": 37.4221, "lng": -122.0841 } } }],
"status": "OK" }reverse_geocode
Convert GPS coordinates to a human-readable street address. Wraps the Google Geocoding API using the brand's own Google Maps key.
| Field | Type | Notes | |
|---|---|---|---|
lat | number | required | Latitude in decimal degrees (−90 to 90), e.g. 13.0975. |
lng | number | required | Longitude in decimal degrees (−180 to 180), e.g. -59.6105. |
{ "results": [{ "formatted_address": "Bridgetown, Barbados" }], "status": "OK" }place_search
near accepts a VayaPin ID (resolved to GPS automatically) or a lat,lng string; omit it for a free-text search. Wraps the Google Places Text/Nearby Search API.
| Field | Type | Notes | |
|---|---|---|---|
query | string | required | What to search for, e.g. coffee shop. |
near | string | optional | A VayaPin ID (BB:TAPAS887) or a lat,lng string. |
radius_km | number | optional | Radius in km (used only with near; max 50). |
{ "results": [{ "name": "...", "place_id": "ChIJ...", "vicinity": "..." }],
"status": "OK" }place_details
Get full details for a specific place (opening hours, photos, rating, phone, website, formatted address) by its Google place_id, as returned by place_search.
| Field | Type | Notes | |
|---|---|---|---|
place_id | string | required | Google place_id, e.g. ChIJN1t_tDeuEmsRUsoyG83frY4. |
{ "result": { "name": "...", "formatted_phone_number": "...",
"opening_hours": { }, "rating": 4.5 }, "status": "OK" }Shipping
track_package
Get real-time tracking status for a shipment. Normalised across 1,200+ carriers via AfterShip. The carrier is auto-detected from the tracking number when omitted.
| Field | Type | Notes | |
|---|---|---|---|
tracking_number | string | required | The carrier tracking number. |
carrier | string | optional | AfterShip courier slug (usps, dhl, fedex). Auto-detected if omitted. |
{ "data": { "tracking": { "tag": "InTransit", "checkpoints": [ ] } } }System
system_health
Check VayaCore API liveness. Returns the service status and version.
No arguments.
{ "status": "healthy", "version": "0.1.0" }