list_locations
Retrieve store location data from the ConsignCloud system to manage retail operations and inventory across multiple sites.
Instructions
List store locations
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Number of results (default: 1000) | |
| cursor | No |
Implementation Reference
- src/server.ts:483-485 (handler)MCP tool handler case for 'list_locations' that prepares parameters and calls client.listLocations, returning JSON stringified result.
case 'list_locations': const locationsParams = { limit: 1000, ...(args as any) }; return { content: [{ type: 'text', text: JSON.stringify(await client.listLocations(locationsParams), null, 2) }] }; - src/server.ts:227-237 (schema)Tool schema definition including name, description, and inputSchema for 'list_locations'.
{ name: 'list_locations', description: 'List store locations', inputSchema: { type: 'object', properties: { limit: { type: 'number', description: 'Number of results (default: 1000)' }, cursor: { type: 'string' }, }, }, }, - src/client.ts:289-292 (helper)Client method implementing listLocations by making a GET request to the ConsignCloud API '/locations' endpoint with optional parameters.
async listLocations(params?: Record<string, any>): Promise<PaginatedResponse<Location>> { const response = await this.client.get('/locations', { params }); return response.data; }