> ## Documentation Index
> Fetch the complete documentation index at: https://docs.colossal.sh/llms.txt
> Use this file to discover all available pages before exploring further.
# Tools
> LLM-callable functions used by the Custom agent step and the chat agent. Reads fetch data. Writes mutate state and run through approval policy.
Tools are LLM-callable functions. They are used by the [Custom agent step](/automations/step-types#let-an-agent-decide) inside automations and by the chat agent in the dashboard. Each tool has a kind. **Read** tools fetch data. **Write** tools mutate state and run through your configured approval policy before running.
## Customers
### Read tools
Get customer details by UID or email. Returns email, full name, created\_at, and order count.
**Input**
The customer's UUID
The customer's email address
**Output**
### Write tools
Create a new customer record.
**Input**
Customer email address.
Customer full name.
**Output**
Update a customer record.
**Input**
The customer's database ID.
New email address.
New full name.
**Output**
## Insights
### Read tools
Query the project's analytics data.
**Input**
## Invoices
### Read tools
Get invoice details by UID, including status, totals, line items, and billing info.
**Input**
The invoice's UUID
**Output**
### Write tools
Create an invoice for a customer.
**Input**
The customer's database ID.
List of line items, each with description, quantity, unit\_price.
ISO 4217 currency code (default: usd). *Default: `"usd"`.*
**Output**
Append a line item to an existing invoice.
**Input**
The invoice's UUID.
Line item title.
Quantity (>=1).
Unit price in the invoice's smallest currency unit.
Optional product ID linking the item to a product.
Optional description.
**Output**
## Notifications
### Read tools
Browse project notifications with filters.
**Input**
*Default: `true`.*
*Default: `false`.*
*Default: `true`.*
*Default: `25`.*
**Output**
## Orders
### Read tools
Get order details by UID including line items and customer info.
**Input**
The order's UUID
**Output**
Get a customer's recent order history. Returns orders with totals, status, and line items.
**Input**
The customer's database ID
Max orders to return (default 20) *Default: `20`.*
**Output**
Browse the most recent orders.
**Input**
*Default: `10`.*
### Write tools
Update the billing address on an order.
**Input**
The order's UUID.
Street address line 1.
City name.
Postal/ZIP code.
ISO country code (e.g. 'US').
Optional secondary address line.
Optional state/region code.
**Output**
Update fields on an order (whitelisted by the order's agent-updatable fields).
**Input**
The order's database ID.
Dict of writable fields to apply (subject to the order's
agent-updatable whitelist).
**Output**
Update an order's integration metadata.
**Input**
The order's database ID.
Metadata fields to merge into the order record.
**Output**
Update an order's status. Pauses for approval before running.
**Input**
The order's database ID.
New status. Cannot be 'refunded' or 'cancelled' (those have dedicated flows).
**Output**
Update the shipping address on an order.
**Input**
The order's UUID.
Street address line 1.
City name.
Postal/ZIP code.
ISO country code (e.g. 'US').
Optional secondary address line.
Optional state/region code.
**Output**
## Payments
### Read tools
Get payment details by UID, including amount, status, and method.
**Input**
The payment's UUID
**Output**
## Products
### Read tools
Get product details by UID, including name, description, archive state, and default variant.
**Input**
The product's UUID
**Output**
Browse the project's products.
**Input**
### Write tools
Archive a product deliverable.
**Input**
The deliverable's UUID.
**Output**
Archive a product so it stops appearing on the storefront.
**Input**
The product's UUID.
**Output**
Create a new product deliverable.
**Input**
Deliverable type identifier.
Display name.
Optional type-specific configuration.
**Output**
Create a new price for a product variant.
**Input**
The variant's UUID.
Unit price.
ISO 4217 currency code (default: USD). *Default: `"USD"`.*
Optional human-readable name for the price.
Optional 'month' or 'year' for subscriptions.
Whether to mark this as the default price for the variant. *Default: `false`.*
**Output**
Publish a product so it appears on the storefront.
**Input**
The product's UUID.
**Output**
Mark a price as the default for its variant.
**Input**
The price's UUID.
**Output**
Unarchive a product.
**Input**
The product's UUID.
**Output**
Update a product deliverable.
**Input**
The deliverable's UUID.
Optional new name.
Optional new type identifier.
Optional new configuration.
**Output**
## Web search
### Read tools
Fetch the content of a public web page.
**Input**
Search the public web.
**Input**
*Default: `5`.*