update-ranking-rules
Modify ranking rules in a Meilisearch index to control how search results are ordered and prioritized.
Instructions
Update the ranking rules 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)Shared handler logic for the update-ranking-rules tool. Parses the input 'value' as JSON and performs a PUT request to the Meilisearch API endpoint for ranking-rules settings.
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:190-194 (registration)Configuration object in updateSettingsTools array that registers the 'update-ranking-rules' tool with endpoint 'ranking-rules'.
{ name: "update-ranking-rules", endpoint: "ranking-rules", description: "Update the ranking rules setting", }, - src/tools/settings-tools.ts:232-235 (schema)Zod input schema for the update-ranking-rules tool parameters: indexUid and value (JSON string).
{ 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)The forEach loop that dynamically registers all update tools, including 'update-ranking-rules', on the MCP server.
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); } } ); });