update-faceting
Modify faceting settings for a Meilisearch index to customize how search results are categorized and filtered based on attributes.
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)The handler function for the 'update-faceting' tool. It parses the 'value' parameter as JSON and performs a PUT request to `/indexes/{indexUid}/settings/faceting` via apiClient to update the faceting settings, returning the response or an error.
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)Zod input schema for the 'update-faceting' tool, requiring 'indexUid' (string) and 'value' (string containing JSON for the 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:215-219 (registration)Configuration object within the updateSettingsTools array that defines the name, endpoint ('faceting'), and description for the 'update-faceting' tool used in dynamic registration.
{ name: "update-faceting", endpoint: "faceting", description: "Update the faceting setting", }, - src/tools/settings-tools.ts:227-250 (registration)forEach loop that dynamically registers the 'update-faceting' tool (and others) by calling server.tool() with the configuration from updateSettingsTools, including schema and handler.
// Create an update tool for each specific setting updateSettingsTools.forEach(({ name, endpoint, description }) => { 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); } } ); });