get_pricing_history
Retrieve paginated history of competitor pricing monitoring runs with completion timestamps. Track pricing changes over time and access specific run details using runId.
Instructions
Get paginated history of Pricing Intelligence monitoring runs with completion timestamps. Use this to track how competitor pricing changes over time. Retrieve specific run data with get_pricing_run_detail using the runId from this response. Read-only. Returns paginated JSON array with pagination.hasMore flag.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| projectId | Yes | Project ID (from list_projects) | |
| page | No | Page number (1-indexed, default: 1) | |
| limit | No | Items per page (default: 20, max: 100) |
Implementation Reference
- src/index.ts:16-25 (handler)Generic handler loop — the tool 'get_pricing_history' is handled by this loop which calls apiGet with the tool's path and queryParams. There is no dedicated handler function; the generic runtime dispatches based on the tool definition.
for (const tool of tools) { server.tool(tool.name, tool.description, tool.parameters.shape, async (args: Record<string, any>) => { const path = tool.path(args); const query: Record<string, any> = {}; for (const key of tool.queryParams ?? []) { if (args[key] !== undefined) query[key] = args[key]; } return apiGet(path, Object.keys(query).length ? query : undefined); }); } - src/tools.ts:230-239 (schema)Tool definition for 'get_pricing_history' — defines the name, description, Zod input schema (projectId + pagination), the API path (/v1/projects/{projectId}/pricing/history), and query parameters (page, limit).
{ name: "get_pricing_history", description: "Get paginated history of Pricing Intelligence monitoring runs with completion timestamps. Use this to track how competitor pricing changes over time. Retrieve specific run data with get_pricing_run_detail using the runId from this response. Read-only. Returns paginated JSON array with pagination.hasMore flag.", parameters: z.object({ projectId: objectId("Project ID (from list_projects)"), ...pagination, }), path: (a) => `/v1/projects/${a.projectId}/pricing/history`, queryParams: ["page", "limit"], - src/index.ts:16-25 (registration)The tool is registered generically by iterating over the tools array and calling server.tool() for each one, including 'get_pricing_history'.
for (const tool of tools) { server.tool(tool.name, tool.description, tool.parameters.shape, async (args: Record<string, any>) => { const path = tool.path(args); const query: Record<string, any> = {}; for (const key of tool.queryParams ?? []) { if (args[key] !== undefined) query[key] = args[key]; } return apiGet(path, Object.keys(query).length ? query : undefined); }); } - src/api-client.ts:3-58 (helper)apiGet helper — the actual HTTP request function called by the handler. Makes a GET request to the CompetLab API with CL-API-Key header and optional query params.
export async function apiGet( path: string, query?: Record<string, string | number>, ): Promise<{ content: Array<{ type: "text"; text: string }>; isError?: true }> { const apiKey = process.env.COMPETLAB_API_KEY; if (!apiKey) { return { content: [ { type: "text", text: JSON.stringify({ error: "api_key_missing", message: "COMPETLAB_API_KEY environment variable is not set", }), }, ], isError: true, }; } const url = new URL(`${API_BASE}${path}`); if (query) { for (const [k, v] of Object.entries(query)) { if (v !== undefined) url.searchParams.set(k, String(v)); } } try { const res = await fetch(url, { headers: { "CL-API-Key": apiKey }, }); const body = await res.text(); if (!res.ok) { return { content: [{ type: "text", text: body }], isError: true }; } return { content: [{ type: "text", text: body }] }; } catch (err) { return { content: [ { type: "text", text: JSON.stringify({ error: "api_unreachable", message: err instanceof Error ? err.message : "Failed to reach CompetLab API", status: 503, }), }, ], isError: true, }; } } - src/tools.ts:9-18 (helper)Pagination helper — the schema reuse helper used by get_pricing_history to define optional page/limit parameters.
const pagination = { page: z.number().int().min(1).optional().describe("Page number (1-indexed, default: 1)"), limit: z .number() .int() .min(1) .max(100) .optional() .describe("Items per page (default: 20, max: 100)"), };