update-filterable-attributes
Modify which document fields can be used as search filters in a Meilisearch index to refine query results.
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 function that parses the input value as JSON and sends a PUT request to the Meilisearch API endpoint for updating filterable attributes (`/indexes/{indexUid}/settings/filterable-attributes`). 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)Input schema using Zod: requires indexUid (string) and value (string representing JSON for the setting).
{ indexUid: z.string().describe("Unique identifier of the index"), value: z.string().describe("JSON value for the setting"), }, - src/tools/settings-tools.ts:180-184 (registration)Configuration object in updateSettingsTools array that defines the tool name, endpoint, and description for dynamic registration.
{ name: "update-filterable-attributes", endpoint: "filterable-attributes", description: "Update the filterable attributes setting", }, - src/tools/settings-tools.ts:228-249 (registration)Dynamic registration loop that creates the server.tool call for 'update-filterable-attributes' using the config, schema, and handler.
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)Top-level call to registerSettingsTools(server), which registers all settings tools including 'update-filterable-attributes'.
registerSettingsTools(server);