get-ranking-rules
Retrieve ranking rules for a specific index in Meilisearch to customize and optimize search result ordering using the Model Context Protocol.
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:154-163 (handler)Handler function that retrieves the ranking rules setting for a given Meilisearch index by calling the API endpoint `/indexes/${indexUid}/settings/ranking-rules` using the dynamically provided endpoint.}, 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-153 (schema)Zod input schema for the tool, defining the required indexUid parameter.{ 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 name, endpoint, and description specifically for the get-ranking-rules tool.{ name: "get-ranking-rules", endpoint: "ranking-rules", description: "Get the ranking rules setting", },
- src/tools/settings-tools.ts:147-165 (registration)forEach loop that registers the get-ranking-rules tool (and other specific settings getters) by calling server.tool with the configuration from the array.// 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 on the MCP server instance, which executes the registration of all settings tools including get-ranking-rules.registerSettingsTools(server);