Skip to main content
Glama
OrionPotter

Meilisearch MCP Server

by OrionPotter

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
NameRequiredDescriptionDefault
indexUidYesUnique identifier of the index
valueYesJSON value for the setting

Implementation Reference

  • 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);
      }
    }
  • 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"),
    },
  • 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",
    },
  • 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);

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

C2.7/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries full burden for behavioral disclosure. 'Update' implies a mutation operation, but the description doesn't specify whether this requires special permissions, what happens to existing ranking rules, whether changes are immediate or asynchronous, or potential side effects. It mentions nothing about rate limits, authentication needs, or error conditions.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence with zero wasted words. It's appropriately sized for a simple update operation and front-loads the essential information. Every word earns its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a mutation tool with no annotations and no output schema, the description is inadequate. It doesn't explain what ranking rules are, what format the JSON value should take, what happens after the update, or how to verify success. Given the complexity of updating a core search setting and the lack of structured documentation, more context is needed.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, with both parameters clearly documented in the schema. The description adds no additional parameter information beyond what's in the schema (indexUid and value). Since the schema does the heavy lifting, the baseline score of 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description 'Update the ranking rules setting' clearly states the action (update) and target (ranking rules setting), but it's vague about what ranking rules are and doesn't differentiate from sibling tools like 'reset-ranking-rules' or 'get-ranking-rules'. It provides basic purpose but lacks specificity about what ranking rules control or affect.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance is provided about when to use this tool versus alternatives like 'reset-ranking-rules' (which presumably resets to defaults) or 'get-ranking-rules' (which retrieves current values). The description doesn't mention prerequisites, context, or exclusions for usage.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.