Skip to main content
Glama
OrionPotter

Meilisearch MCP Server

by OrionPotter

reset-displayed-attributes

Restore default displayed attributes for a Meilisearch index to control which fields appear in search results.

Instructions

Reset the displayed attributes setting to its default value

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
indexUidYesUnique identifier of the index

Implementation Reference

  • Handler function that executes the reset-displayed-attributes tool logic by sending a DELETE request to the Meilisearch API endpoint for displayed-attributes settings.
    async ({ indexUid }) => {
      try {
        const response = await apiClient.delete(`/indexes/${indexUid}/settings/${endpoint}`);
        return {
          content: [{ type: "text", text: JSON.stringify(response.data, null, 2) }],
        };
      } catch (error) {
        return createErrorResponse(error);
      }
    }
  • Input schema definition using Zod for the tool, requiring the indexUid parameter.
    {
      indexUid: z.string().describe("Unique identifier of the index"),
    },
  • Configuration object in the resetSettingsTools array that defines the tool's name, endpoint, and description for dynamic registration.
    {
      name: "reset-displayed-attributes",
      endpoint: "displayed-attributes",
      description: "Reset the displayed attributes setting to its default value",
    },
  • src/index.ts:67-67 (registration)
    Top-level call to registerSettingsTools on the MCP server instance, which includes registration of the reset-displayed-attributes tool.
    registerSettingsTools(server);

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.1/5.0
Behavior2/5

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

No annotations are provided, so the description carries full burden. It states 'reset' implies a mutation, but doesn't disclose behavioral traits like whether this requires admin permissions, if it's reversible, what happens to existing settings, or if it triggers background tasks. 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 a single, efficient sentence with zero waste. It's front-loaded with the core action and target, making it easy to parse quickly without unnecessary elaboration.

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

Completeness3/5

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

Given the tool's complexity (simple reset operation), 100% schema coverage, and no output schema, the description is minimally adequate. However, for a mutation tool with no annotations, it should ideally include more behavioral context like side effects or permissions, leaving some gaps in completeness.

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 the single parameter 'indexUid' documented as 'Unique identifier of the index'. The description doesn't add any meaning beyond this, such as format examples or constraints, but the schema provides adequate baseline information.

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

Purpose4/5

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

The description clearly states the action ('reset') and the target ('displayed attributes setting to its default value'), providing specific verb+resource. However, it doesn't explicitly differentiate from sibling tools like 'get-displayed-attributes' or 'update-displayed-attributes', which would be needed for a perfect score.

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?

The description provides no guidance on when to use this tool versus alternatives like 'update-displayed-attributes' or 'get-displayed-attributes'. It lacks context about prerequisites, such as whether the index must exist or be in a specific state, and doesn't mention any exclusions or typical use cases.

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