Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.nippy.la/llms.txt

Use this file to discover all available pages before exploring further.

​
Examples of what you can ask your agent

  • “What products do I have in inventory and how many of each are left?”
  • “Is anything below the minimum stock? Tell me what needs urgent replenishment”
  • “Show me the distribution centers I have and what’s in each”
  • “Register a delivery of 3 uniforms to Carlos at the Guadalajara center”
  • “How many withdrawals were there in April? Give me the full history”
Supply lets you manage your entire inventory from chat. Check what’s available, get alerts when something is running low, and record movements. Operations that modify data (creating centers, assigning stock, recording withdrawals) always show a preview before executing — nothing is written without your confirmation.

​
Read tools

​
supply_list_stocks

Lists the global product catalog (stock) for this business.
​
limit
integer
default:"100"
Maximum number of items to return.
Response includes: _id, productName, totalStock, minStockAlert, type, createdAt 
{
  "name": "supply_list_stocks",
  "arguments": {
    "limit": 50
  }
}

​
supply_list_nippy_center_stocks

Lists stock levels per Nippy Center. Optionally filters by a specific center.
​
nippy_center_id
string
default:"''"
Nippy Center ID. If omitted, returns all centers for the business.
​
limit
integer
default:"100"
Maximum number of items to return.
Response includes: _id, stockId, nippyCenterId, currentStock, minStockAlert, criticality, productName 
{
  "name": "supply_list_nippy_center_stocks",
  "arguments": {
    "nippy_center_id": "64aed18101d27bba60dce608",
    "limit": 100
  }
}

​
supply_get_low_stock_alerts

Lists all items where current stock is below the configured minimum threshold.
​
limit
integer
default:"100"
Maximum number of alerts to return.
Response includes: items with currentStock < minStockAlert, with productName joined from the catalog. 
{
  "name": "supply_get_low_stock_alerts",
  "arguments": {
    "limit": 20
  }
}

​
supply_get_withdrawal_history

Lists the withdrawal history for this business within a date range.
​
date_from
string
default:"''"
Start date in ISO 8601 format, e.g. "2026-01-01". Optional.
​
date_to
string
default:"''"
End date in ISO 8601 format, e.g. "2026-05-08". Optional.
​
limit
integer
default:"50"
Maximum number of withdrawals to return.
{
  "name": "supply_get_withdrawal_history",
  "arguments": {
    "date_from": "2026-05-01",
    "date_to": "2026-05-08",
    "limit": 100
  }
}

​
supply_list_nippy_centers

Lists the Nippy Centers (distribution points) for the business.
​
limit
integer
default:"100"
Maximum number of centers to return.
Response includes: _id, name, address, geo, capacity, schedule, isActive, type 
{
  "name": "supply_list_nippy_centers",
  "arguments": {
    "limit": 50
  }
}

​
Write tools — Nippy Centers

​
supply_propose_nippy_center

Generates a preview of the Nippy Center before creating it. Does not write to the database.
​
name
string
required
Nippy Center name.
​
address
string
default:"''"
Physical address of the center.
​
lat
float
default:"0.0"
Latitude for Google Maps.
​
long
float
default:"0.0"
Longitude for Google Maps.
​
google_maps_link
string
default:"''"
Google Maps URL. If omitted, it is generated automatically from lat/long.
​
active_member_duration
integer
default:"30"
Appointment duration for active members (minutes).
​
non_member_duration
integer
default:"15"
Appointment duration for non-members (minutes).
​
capacity
integer
default:"50"
Maximum capacity of the center.
​
country_id
string
default:"''"
Country ID. If omitted, uses the business default.
​
type
string
default:"'physical'"
Center type: "physical" or "online".
​
is_active
boolean
default:"true"
Whether the center is active.
{
  "name": "supply_propose_nippy_center",
  "arguments": {
    "name": "Centro Norte CDMX",
    "address": "Av. Insurgentes 123, CDMX",
    "lat": 19.4326,
    "long": -99.1332,
    "capacity": 80,
    "type": "physical"
  }
}

​
supply_create_nippy_center

Creates the Nippy Center in the database. Same parameters as propose_nippy_center.
Only call this tool after showing the user the propose_nippy_center preview and receiving explicit confirmation.
Response: {"_id": "...", "name": "Centro Norte CDMX", "status": "created"}

​
Write tools — Global stock

​
supply_propose_stock

Generates a preview of the stock product before creating it. Does not write to the database.
​
product_name
string
required
Product name.
​
total_stock
integer
required
Initial total stock quantity.
​
min_stock_alert
integer
required
Minimum threshold for low inventory alerts.
​
type
string
default:"''"
Product category, e.g. "supply", "prize", "uniform". Optional.
{
  "name": "supply_propose_stock",
  "arguments": {
    "product_name": "Nippy Backpack 2026",
    "total_stock": 500,
    "min_stock_alert": 50,
    "type": "prize"
  }
}

​
supply_create_stock

Creates the product in the global catalog. Same parameters as propose_stock.
Only call this tool after showing the user the propose_stock preview and receiving explicit confirmation.
Response: {"_id": "...", "productName": "Nippy Backpack 2026", "status": "created"}

​
Write tools — Stock per Nippy Center

​
supply_propose_nippy_center_stock

Generates a preview of stock assignment to a Nippy Center. Does not write to the database.
​
stock_id
string
required
Product ID from the global catalog (from list_stocks).
​
nippy_center_id
string
required
Nippy Center ID (from list_nippy_centers).
​
current_stock
integer
required
Stock quantity to assign to the center.
​
min_stock_alert
integer
required
Minimum threshold for alerts at this center.
​
criticality
string
default:"''"
Criticality level: "low", "medium", "high". Optional.
{
  "name": "supply_propose_nippy_center_stock",
  "arguments": {
    "stock_id": "664f1a2b3c4d5e6f7a8b9c0d",
    "nippy_center_id": "64aed18101d27bba60dce608",
    "current_stock": 100,
    "min_stock_alert": 10,
    "criticality": "high"
  }
}

​
supply_create_nippy_center_stock

Assigns stock to a Nippy Center. Same parameters as propose_nippy_center_stock.
Validates that both the stock and the center belong to the business before writing.
Response: {"_id": "...", "status": "created"}

​
Write tools — Withdrawals

​
supply_propose_withdrawal

Generates a withdrawal preview and validates stock availability. Does not write to the database. Verifies that:
  • The Nippy Center belongs to the business
  • The stock belongs to the business
  • There is enough stock at the center for the requested quantity
​
stock_id
string
required
ID of the product to withdraw.
​
nippy_center_id
string
required
ID of the Nippy Center to withdraw from.
​
worker_id
string
required
ID of the worker receiving the withdrawal.
​
email
string
required
Worker’s email.
​
quantity
integer
required
Quantity to withdraw.
​
withdrawal_type
string
default:"'insumos'"
Withdrawal type. Check nippy://supply/schema/withdrawals for available types.
​
entregador
string
default:"''"
Delivery person name. Optional.
​
tipo_entrega
string
default:"''"
Delivery type. Optional.
​
ciudad
string
default:"''"
City. Optional.
​
talla
string
default:"''"
Size (for uniforms or other sized items). Optional.
{
  "name": "supply_propose_withdrawal",
  "arguments": {
    "stock_id": "664f1a2b3c4d5e6f7a8b9c0d",
    "nippy_center_id": "64aed18101d27bba60dce608",
    "worker_id": "665c8d4e5f6a7b8c9d0e1f2a",
    "email": "worker@nippy.la",
    "quantity": 2,
    "withdrawal_type": "insumos"
  }
}

​
supply_approve_withdrawal

Executes the withdrawal. Decrements stock at the Nippy Center and records the delivery. Same parameters as propose_withdrawal.
Only call this tool after showing the propose_withdrawal preview and receiving explicit confirmation. This operation is atomic and irreversible.
Response: {"_id": "...", "status": "created"}

​
Full withdrawal flow

1. supply_list_nippy_centers          → get center IDs
2. supply_list_stocks                 → get product IDs
3. supply_list_nippy_center_stocks    → check available stock at the center
4. supply_propose_withdrawal          → preview + stock availability validation
5. [user confirms]
6. supply_approve_withdrawal          → execute withdrawal (decrements stock + creates record)
Schema references for the agent:
URINameDescription
nippy://supply/schema/stocksupply_stock_schemaGlobal stock and per-center stock fields
nippy://supply/schema/withdrawalssupply_withdrawal_schemaWithdrawal types and flow rules
nippy://supply/schema/centerssupply_nippy_center_schemaNippy Center fields and scheduling