get-ranking-rules
Retrieve ranking rules configuration for a Meilisearch index to understand how search results are prioritized and ordered.
Instructions
Get the ranking rules setting
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| indexUid | Yes | Unique identifier of the index |
Implementation Reference
- src/tools/settings-tools.ts:155-164 (handler)Handler function that fetches the ranking rules setting from the Meilisearch API endpoint `/indexes/${indexUid}/settings/ranking-rules` and returns the JSON-formatted response or an error.
async ({ indexUid }) => { try { const response = await apiClient.get(`/indexes/${indexUid}/settings/${endpoint}`); return { content: [{ type: "text", text: JSON.stringify(response.data, null, 2) }], }; } catch (error) { return createErrorResponse(error); } } - src/tools/settings-tools.ts:152-154 (schema)Input schema defining the required 'indexUid' parameter as a string.
{ indexUid: z.string().describe("Unique identifier of the index"), }, - src/tools/settings-tools.ts:110-114 (registration)Configuration object in the specificSettingsTools array that defines the tool name, endpoint, and description for registration.
{ name: "get-ranking-rules", endpoint: "ranking-rules", description: "Get the ranking rules setting", }, - src/tools/settings-tools.ts:147-166 (registration)forEach loop that registers the server.tool for 'get-ranking-rules' and other specific settings tools using the shared schema and handler.
// Create a tool for each specific setting specificSettingsTools.forEach(({ name, endpoint, description }) => { server.tool( name, description, { indexUid: z.string().describe("Unique identifier of the index"), }, async ({ indexUid }) => { try { const response = await apiClient.get(`/indexes/${indexUid}/settings/${endpoint}`); 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 which includes the registration of the 'get-ranking-rules' tool.
registerSettingsTools(server);