update-filterable-attributes
Modify which fields can be used to filter search results in a Meilisearch index, enabling precise data retrieval through attribute-based filtering.
Instructions
Update the filterable attributes 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 that parses the JSON value input, performs a PUT request to update the filterable-attributes setting via apiClient, and returns the response or 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 defining 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:228-250 (registration)Registration loop that dynamically registers the update-filterable-attributes tool (along with others) using server.tool, including its specific endpoint 'filterable-attributes'.
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/tools/settings-tools.ts:180-184 (registration)Specific configuration object in updateSettingsTools array that defines the name, endpoint, and description for the tool.
{ name: "update-filterable-attributes", endpoint: "filterable-attributes", description: "Update the filterable attributes setting", },