getNBM
Retrieve and filter NBM data by language, page, and search terms using the MCP server. Customize results with pagination and additional parameters for precise queries.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| add | No | ||
| language | No | pt | |
| page | No | ||
| perPage | No | ||
| search | No |
Implementation Reference
- src/ComexstatMCP.ts:463-472 (handler)MCP tool handler for 'getNBM' that serializes the result from ComexstatClient.getNBM into JSON text content.content: [ { type: "text", text: JSON.stringify( await this.client.getNBM({ language, page, perPage, add, search }) ), }, ], }) );
- src/ComexstatMCP.ts:456-461 (schema)Input schema (Zod) for the 'getNBM' tool defining optional parameters: language, page, perPage, add, search.language: z.string().optional().default("pt"), page: z.number().optional().default(1), perPage: z.number().optional().default(5), add: z.string().optional(), search: z.string().optional(), },
- src/ComexstatMCP.ts:454-473 (registration)Registration of the 'getNBM' MCP tool on the McpServer instance."getNBM", { language: z.string().optional().default("pt"), page: z.number().optional().default(1), perPage: z.number().optional().default(5), add: z.string().optional(), search: z.string().optional(), }, async ({ language, page, perPage, add, search }) => ({ content: [ { type: "text", text: JSON.stringify( await this.client.getNBM({ language, page, perPage, add, search }) ), }, ], }) );
- src/ComexstatClient.ts:660-683 (helper)ComexstatClient helper method that performs the actual HTTP GET request to the /tables/nbm endpoint to retrieve NBM data.async getNBM(options?: { language?: string; page?: number; perPage?: number; add?: string; search?: string; }): Promise<{ data: { list: Array<{ noNCM: string; // NCM description unit: string; // Measurement unit nbm: string; // NBM description coNbm: string; // NBM code coNcm: string; // NCM code }>; count: number; // Total number of records }; success: boolean; message: string | null; processo_info: any; language: string; }> { return this.get("/tables/nbm", options); }