update-ranking-rules
Modify ranking rules to control how search results are ordered in a Meilisearch index, enabling custom relevance tuning.
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 function for update-* tools, including update-ranking-rules. Parses the 'value' parameter as JSON and performs a PUT request to `/indexes/${indexUid}/settings/ranking-rules` using apiClient.
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) and value (string containing JSON for the new ranking rules).
{ indexUid: z.string().describe("Unique identifier of the index"), value: z.string().describe("JSON value for the setting"), }, - src/tools/settings-tools.ts:190-194 (registration)Configuration object for the 'update-ranking-rules' tool, specifying name, endpoint, and description, used within the updateSettingsTools array for dynamic tool registration.
{ name: "update-ranking-rules", endpoint: "ranking-rules", description: "Update the ranking rules setting", }, - src/tools/settings-tools.ts:227-250 (registration)Dynamic registration loop that creates the server.tool call for 'update-ranking-rules' and other update tools using the configuration array.
// 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/index.ts:67-67 (registration)Top-level registration of all settings tools (including update-ranking-rules) by calling registerSettingsTools on the MCP server instance.
registerSettingsTools(server);