update-faceting
Modify faceting settings in a Meilisearch index to control how search results are categorized and filtered for better user navigation.
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-249 (handler)Handler function that executes the update-faceting tool. Parses the input value as JSON and performs a PUT request to update the faceting settings in Meilisearch.
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 tools, including update-faceting, using Zod to validate indexUid and value parameters.
{ 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)Specific configuration object in the updateSettingsTools array used to register the update-faceting tool.
{ name: "update-faceting", endpoint: "faceting", description: "Update the faceting setting", }, - src/tools/settings-tools.ts:228-250 (registration)Loop that dynamically registers all update-specific tools, including 'update-faceting', by calling server.tool with the configuration from the array.
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); } } ); }); - src/index.ts:67-67 (registration)Invocation of registerSettingsTools on the main MCP server instance, which in turn registers the update-faceting tool.
registerSettingsTools(server);