getHarmonizedSystem
Search and retrieve harmonized system codes for trade classification. Specify language, page, and results per page to streamline trade data navigation.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| add | No | ||
| language | No | pt | |
| page | No | ||
| perPage | No |
Implementation Reference
- src/ComexstatMCP.ts:435-449 (handler)MCP tool handler function for getHarmonizedSystem that receives parameters, calls the ComexstatClient.getHarmonizedSystem method, stringifies the result, and returns it as text content.async ({ language, page, perPage, add }) => ({ content: [ { type: "text", text: JSON.stringify( await this.client.getHarmonizedSystem({ language, page, perPage, add, }) ), }, ], })
- src/ComexstatMCP.ts:429-434 (schema)Zod input schema defining optional parameters: language (default 'pt'), page (default 1), perPage (default 10), and add.{ language: z.string().optional().default("pt"), page: z.number().optional().default(1), perPage: z.number().optional().default(10), add: z.string().optional(), },
- src/ComexstatMCP.ts:427-450 (registration)Registration of the 'getHarmonizedSystem' tool on the MCP server, specifying name, input schema, and handler function.this.server.tool( "getHarmonizedSystem", { language: z.string().optional().default("pt"), page: z.number().optional().default(1), perPage: z.number().optional().default(10), add: z.string().optional(), }, async ({ language, page, perPage, add }) => ({ content: [ { type: "text", text: JSON.stringify( await this.client.getHarmonizedSystem({ language, page, perPage, add, }) ), }, ], }) );
- src/ComexstatClient.ts:622-648 (helper)Supporting client method that performs the actual API GET request to '/tables/hs' endpoint with provided options and returns the Harmonized System classification data.async getHarmonizedSystem(options?: { language?: string; page?: number; perPage?: number; add?: string; }): Promise<{ data: { list: Array<{ noNCM: string; // NCM description unit: string; // Measurement unit subHeadingCode: string; // HS subheading code subHeading: string; // HS subheading description headingCode: string; // HS heading code heading: string; // HS heading description chapterCode: string; // HS chapter code chapter: string; // HS chapter description coNcm: string; // NCM code }>; count: number; // Total number of records }; success: boolean; message: string | null; processo_info: any; language: string; }> { return this.get("/tables/hs", options); }