list_categories
Retrieve available item categories for inventory management and sales tracking in consignment businesses.
Instructions
List item categories
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Number of results (default: 1000) | |
| cursor | No |
Implementation Reference
- src/server.ts:205-215 (registration)Registration of the 'list_categories' tool including its description and input schema for pagination parameters (limit, cursor).{ name: 'list_categories', description: 'List item categories', inputSchema: { type: 'object', properties: { limit: { type: 'number', description: 'Number of results (default: 1000)' }, cursor: { type: 'string' }, }, }, },
- src/server.ts:476-478 (handler)Handler logic for 'list_categories' tool: prepares parameters with default limit, calls client.listCategories(), and returns the JSON-formatted paginated response.case 'list_categories': const categoriesParams = { limit: 1000, ...(args as any) }; return { content: [{ type: 'text', text: JSON.stringify(await client.listCategories(categoriesParams), null, 2) }] };
- src/client.ts:264-267 (helper)Core implementation of listCategories in ConsignCloudClient: performs HTTP GET to '/item-categories' API endpoint with query parameters and returns PaginatedResponse<ItemCategory>.async listCategories(params?: Record<string, any>): Promise<PaginatedResponse<ItemCategory>> { const response = await this.client.get('/item-categories', { params }); return response.data; }
- src/types.ts:60-65 (schema)Type definition for ItemCategory, used in the output of listCategories (PaginatedResponse<ItemCategory>). Also PaginatedResponse defined nearby.export interface ItemCategory { id: string; name: string; created: string; deleted: string | null; }