data_list_cashboxes

Retrieve and list available cash registers from a POS system in JSON, CSV, or HTML format for inventory management and system integration.

Instructions

Liste des Lister les caisses

Input Schema

TableJSON Schema

Name	Required	Description	Default
`format`	No		json

Implementation Reference

src/tools/data.ts:90-114 (handler)

Handler function that fetches cashbox data from '/workers/getCashbox.php' using authenticated shopId and apiKey, formats it, and returns structured content via structData. Handles errors gracefully.

async ({ format }: CommonArgs, ctx: Ctx) => {
    try {
        const { shopId, apiKey } = resolveAuth(undefined, ctx);
        const data = await get(path, { idboutique: shopId, key: apiKey, format });

        process.stderr.write(
            `[caisse][tool:${toolName}] ok type=${Array.isArray(data) ? 'array' : typeof data}`
            + (Array.isArray(data) ? ` len=${data.length}` : '')
            + '\n'
        );
        //Array.isArray(data) ? data.slice(0, 50) : data
        const funcResult = structData( data);
        process.stderr.write(`[caisse][RES]  ${JSON.stringify(data)} \n`);
        process.stderr.write(`[caisse][RES] funcResult ${JSON.stringify(funcResult)} \n`);
        return funcResult;
        //return { content, structuredContent: isText ? undefined : data };
    } catch (e) {
        process.stderr.write(`[caisse][tool:${toolName}][error]\n`);
        process.stderr.write(`[caisse][tool:${toolName}][error] ${(e as Error).message}\n`);
        // renvoyer un message "propre" plutôt que laisser l’exception devenir un 424
        return {
            content: [{ type: 'text', text: `Erreur pendant la préparation de la réponse: ${(e as Error).message}` }],
            is_error: true,
        };
    }

src/tools/data.ts:11-13 (schema)
Input schema for the tool: optional 'format' parameter with values 'json', 'csv', or 'html' (defaults to 'json').
```
const CommonShape = {
    format: z.enum(['json', 'csv', 'html']).default('json'),
} satisfies Record<string, ZodTypeAny>;
```
src/tools/data.ts:129-129 (registration)
Registration of the 'data_list_cashboxes' tool within registerDataTools, using the shared registerSimple helper with specific endpoint and labels.
```
registerSimple(server, 'data_list_cashboxes', '/workers/getCashbox.php', t('tools.data_list_cashboxes.description'), t('tools.data_list_cashboxes.title'));
```

src/tools/data.ts:75-117 (helper)

Helper function registerSimple that creates and registers simple list tools, including schema, description template, and standard fetch handler.

function registerSimple(
    server: McpServer | any,
    toolName: string,
    path: string,
    title: string,
    entityLabel: string
) {
    server.registerTool(
        toolName,
        {
            title,
            description: `Liste des ${entityLabel}`,
            inputSchema: CommonShape, // ZodRawShape,
            annotations: { readOnlyHint: true }
        },
        async ({ format }: CommonArgs, ctx: Ctx) => {
            try {
                const { shopId, apiKey } = resolveAuth(undefined, ctx);
                const data = await get(path, { idboutique: shopId, key: apiKey, format });

                process.stderr.write(
                    `[caisse][tool:${toolName}] ok type=${Array.isArray(data) ? 'array' : typeof data}`
                    + (Array.isArray(data) ? ` len=${data.length}` : '')
                    + '\n'
                );
                //Array.isArray(data) ? data.slice(0, 50) : data
                const funcResult = structData( data);
                process.stderr.write(`[caisse][RES]  ${JSON.stringify(data)} \n`);
                process.stderr.write(`[caisse][RES] funcResult ${JSON.stringify(funcResult)} \n`);
                return funcResult;
                //return { content, structuredContent: isText ? undefined : data };
            } catch (e) {
                process.stderr.write(`[caisse][tool:${toolName}][error]\n`);
                process.stderr.write(`[caisse][tool:${toolName}][error] ${(e as Error).message}\n`);
                // renvoyer un message "propre" plutôt que laisser l’exception devenir un 424
                return {
                    content: [{ type: 'text', text: `Erreur pendant la préparation de la réponse: ${(e as Error).message}` }],
                    is_error: true,
                };
            }
        }
    );
}

src/tools/data.ts:52-73 (helper)

Helper function structData used by the handler to format the response with preview text and structured content.

function structData(data: any) {
    // on ne touche PAS à structuredContent (c’est ce que ChatGPT utilise)
    const light = Array.isArray(data)
        ? data.slice(0, 5000)//.map(({ id, nom, email, tel, ...r }) => ({ id, nom, email, tel }))
        : data;

    const maxLength = 40000;
    const preview =
        typeof light === 'string'
            ? (light.length > maxLength ? light.slice(0, maxLength) + '…(truncated)' : light)
            : safeStringify(light, 2, maxLength);   // <-- aperçu court et “safe”
    const wrapped =
        Array.isArray(data)
            ? { data: data }
            : data && typeof data === 'object'
                ? data
                : { data: data };
    return {
        content: [{ type: 'text', text: preview }],
        structuredContent: wrapped,
    };
}

caisse-enregistreuse-mcp-server