Skip to main content
Glama
devlimelabs

Meilisearch MCP Server

by devlimelabs

update-sortable-attributes

Modify which fields can be used for sorting search results in a Meilisearch index, enabling customized result ordering based on specific attributes.

Instructions

Update the sortable attributes setting

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
indexUidYesUnique identifier of the index
valueYesJSON value for the setting

Implementation Reference

  • Shared handler function for update-specific-settings tools. Parses the 'value' parameter as JSON and sends a PUT request to update the 'sortable-attributes' setting via the Meilisearch API.
    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 schema defining the input parameters for the tool: indexUid (string) and value (string containing JSON for the new sortable attributes).
    {
      indexUid: z.string().describe("Unique identifier of the index"),
      value: z.string().describe("JSON value for the setting"),
    },
  • Configuration object in the updateSettingsTools array used to dynamically register the 'update-sortable-attributes' tool with its specific endpoint.
    {
      name: "update-sortable-attributes",
      endpoint: "sortable-attributes",
      description: "Update the sortable attributes setting",
    },
  • src/index.ts:67-67 (registration)
    Invocation of registerSettingsTools on the MCP server instance, which triggers the dynamic registration of the tool including its handler and schema.
    registerSettingsTools(server);
Behavior1/5

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

No annotations are provided, so the description carries full burden for behavioral disclosure. It states 'update' which implies a mutation/write operation, but provides no information about permissions required, whether changes are immediate or asynchronous, error conditions, or what happens to existing settings. For a mutation tool with zero annotation coverage, this is inadequate.

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 extremely concise at just 5 words. It's front-loaded with the core action and resource. While it's under-specified in terms of content, it doesn't waste words or include redundant information. Every word serves a purpose in the minimal description provided.

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?

Given this is a mutation tool with no annotations and no output schema, the description is incomplete. It doesn't explain what sortable attributes are, what format the JSON value should take, whether the operation is synchronous, or what happens on success/failure. For a tool that modifies index settings in a system with many configuration options, 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 (indexUid, value) clearly documented in the schema. The description adds no additional parameter information beyond what the schema provides. According to scoring rules, when schema coverage is high (>80%), the baseline is 3 even with no param info in the description.

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

Purpose2/5

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

The description 'Update the sortable attributes setting' is a tautology that essentially restates the tool name. It specifies the verb 'update' and resource 'sortable attributes setting', but lacks specificity about what sortable attributes are or what this operation actually does. Compared to siblings like 'get-sortable-attributes' or 'reset-sortable-attributes', it doesn't clearly differentiate beyond the basic action verb.

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

Usage Guidelines1/5

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

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites (e.g., needing an existing index), when-not-to-use scenarios, or direct alternatives like 'reset-sortable-attributes' for clearing settings. With many sibling tools for managing index settings, this absence of contextual guidance is a significant gap.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/devlimelabs/meilisearch-ts-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server