update-faceting
Modify faceting settings in a Meilisearch index by specifying the index UID and JSON value, enabling precise control over search result categorization and filtering.
Instructions
Update the faceting setting
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| indexUid | Yes | Unique identifier of the index | |
| value | Yes | JSON value for the setting |
Implementation Reference
- src/tools/settings-tools.ts:236-248 (handler)Handler function that executes the 'update-faceting' tool. Parses the JSON value and performs a PUT request to the Meilisearch API to update the faceting settings for the specified index.async ({ indexUid, value }) => { try { // Parse the value string to ensure it's valid JSON const parsedValue = JSON.parse(value); const response = await apiClient.put(`/indexes/${indexUid}/settings/${endpoint}`, parsedValue); return { content: [{ type: "text", text: JSON.stringify(response.data, null, 2) }], }; } catch (error) { return createErrorResponse(error); } }
- src/tools/settings-tools.ts:232-235 (schema)Input schema for the 'update-faceting' tool using Zod validation. Requires indexUid (string) and value (JSON string for faceting settings).{ indexUid: z.string().describe("Unique identifier of the index"), value: z.string().describe("JSON value for the setting"), },
- src/tools/settings-tools.ts:229-249 (registration)Registration of the 'update-faceting' tool via dynamic loop using server.tool(). The endpoint is set to 'faceting' from the config.server.tool( name, description, { indexUid: z.string().describe("Unique identifier of the index"), value: z.string().describe("JSON value for the setting"), }, async ({ indexUid, value }) => { try { // Parse the value string to ensure it's valid JSON const parsedValue = JSON.parse(value); const response = await apiClient.put(`/indexes/${indexUid}/settings/${endpoint}`, parsedValue); return { content: [{ type: "text", text: JSON.stringify(response.data, null, 2) }], }; } catch (error) { return createErrorResponse(error); } } );
- src/tools/settings-tools.ts:215-219 (registration)Configuration object defining the 'update-faceting' tool name, endpoint, and description used in the registration loop.{ name: "update-faceting", endpoint: "faceting", description: "Update the faceting setting", },