update-sortable-attributes
Configure which fields can be used to sort search results in a Meilisearch index. Specify the index and JSON array of sortable attributes to customize search result ordering.
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)The handler function for the 'update-sortable-attributes' tool (shared with other update tools). Parses the input value as JSON and sends 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)Input schema validation using Zod for the update tools, including 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:227-249 (registration)The registration loop that dynamically registers the 'update-sortable-attributes' tool (and others) with the MCP server using server.tool().
// 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); } } ); - src/tools/settings-tools.ts:185-189 (registration)Configuration object in the updateSettingsTools array that specifies the name, endpoint, and description for the 'update-sortable-attributes' tool.
{ name: "update-sortable-attributes", endpoint: "sortable-attributes", description: "Update the sortable attributes setting", },