Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| CONSIGNCLOUD_API_KEY | Yes | Your ConsignCloud API key (obtained from Settings → Apps → API & Webhooks) | |
| CONSIGNCLOUD_API_BASE_URL | No | The base URL for the ConsignCloud API | https://api.consigncloud.com/api/v1 |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| list_items | List inventory items with optional filters. Supports filtering by price, category, account, status, location, and more. |
| get_item | Get details of a specific inventory item by ID |
| create_item | Create a new inventory item |
| update_item | Update an existing inventory item |
| delete_item | Delete (soft delete) an inventory item |
| get_item_stats | Get overall inventory statistics |
| list_sales | List sales with optional filters |
| get_sale | Get details of a specific sale |
| void_sale | Void a sale |
| list_accounts | List vendor/consignor accounts with optional filters |
| get_account | Get details of a specific account |
| create_account | Create a new vendor/consignor account |
| update_account | Update an existing account |
| get_account_stats | Get statistics for a specific account (balance, items, sales) |
| list_categories | List item categories |
| create_category | Create a new item category |
| list_locations | List store locations |
| search_suggest | Search across accounts and items using full-text search. Returns matching entities with their full details. |
| suggest_field_values | Get auto-complete suggestions for a specific field (brand, color, size, tags, etc.) based on existing data. |
| get_sales_trends | Get sales trends and analytics |
| list_batches | List batches of items |
| create_batch | Create a new batch of items |
| update_batch_status | Update batch status (draft or submitted) |
| calculate_inventory_value | Calculate total inventory value with comprehensive filtering and grouping. Returns total value, item count, average value, and optional breakdown by category, location, account, inventory type, or status. |
| calculate_sales_totals | Calculate sales totals with filtering by date range, status, location, customer, payment type, and amount. Returns total revenue, tax, sale count, average sale value, and optional breakdown by status, location, or date period. |
| calculate_account_metrics | Calculate comprehensive metrics for a specific vendor/consignor account including current balance, inventory value, items available/sold, total sales revenue, and commission owed. |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |