update-sortable-attributes
Modify sortable attributes in Meilisearch indexes to customize search result ordering, ensuring precise data retrieval based on specified criteria.
Instructions
Update the sortable 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)Core handler logic for the update-sortable-attributes tool. Parses the input value as JSON and performs a PUT request to the Meilisearch API to update the sortable attributes setting 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)Zod input schema defining parameters: indexUid (string, Meilisearch index UID) and value (string, JSON-serialized value to set for sortable attributes).{ 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-sortable-attributes tool (and siblings) using server.tool with the specific endpoint 'sortable-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:185-189 (registration)Configuration entry in updateSettingsTools array that specifies the tool name, Meilisearch endpoint, and description for registration.{ name: "update-sortable-attributes", endpoint: "sortable-attributes", description: "Update the sortable attributes setting", },
- src/index.ts:67-67 (registration)Top-level call to registerSettingsTools(server), which includes registration of the update-sortable-attributes tool.registerSettingsTools(server);