Skip to main content
Glama
OrionPotter

Meilisearch MCP Server

by OrionPotter

delete-all-documents

Remove all documents from a Meilisearch index to clear data or reset content for testing and maintenance purposes.

Instructions

Delete all documents in a Meilisearch index

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
indexUidYesUnique identifier of the index

Implementation Reference

  • Handler function that deletes all documents from the specified Meilisearch index using the API client.
    async ({ indexUid }: DeleteAllDocumentsParams) => {
      try {
        const response = await apiClient.delete(`/indexes/${indexUid}/documents`);
        return {
          content: [{ type: 'text', text: JSON.stringify(response.data, null, 2) }],
        };
      } catch (error) {
        return createErrorResponse(error);
      }
    }
  • Zod input schema for the 'delete-all-documents' tool.
    {
      indexUid: z.string().describe('Unique identifier of the index'),
    },
  • TypeScript interface for the tool parameters.
    interface DeleteAllDocumentsParams {
      indexUid: string;
    }
  • Registration of the 'delete-all-documents' tool on the MCP server.
    server.tool(
      'delete-all-documents',
      'Delete all documents in a Meilisearch index',
      {
        indexUid: z.string().describe('Unique identifier of the index'),
      },
      async ({ indexUid }: DeleteAllDocumentsParams) => {
        try {
          const response = await apiClient.delete(`/indexes/${indexUid}/documents`);
          return {
            content: [{ type: 'text', text: JSON.stringify(response.data, null, 2) }],
          };
        } catch (error) {
          return createErrorResponse(error);
        }
      }
    );
  • src/index.ts:65-65 (registration)
    Top-level registration call that includes the document tools module.
    registerDocumentTools(server);
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It states the destructive action ('Delete all documents') but doesn't mention critical aspects like whether this is irreversible, requires specific permissions, triggers background tasks, or has rate limits. For a high-impact mutation tool, this leaves significant gaps in understanding its behavior.

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 that directly states the tool's purpose without unnecessary words. It's appropriately sized and front-loaded, with zero wasted content.

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 destructive tool with no annotations and no output schema, the description is insufficient. It doesn't address critical context like what 'delete all' entails (permanent removal?), whether it's asynchronous (referencing sibling 'wait-for-task'), or what happens to the index structure. The agent lacks necessary information to use this tool safely and effectively.

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' clearly documented in the schema. The description doesn't add any additional meaning about the parameter beyond what's in the schema, so it meets the baseline score of 3 where the schema does the heavy lifting.

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 ('Delete all documents') and the target ('in a Meilisearch index'), providing a specific verb+resource combination. However, it doesn't explicitly differentiate from sibling tools like 'delete-document' (singular) or 'delete-documents' (batch), leaving some ambiguity about scope.

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 on when to use this tool versus alternatives like 'delete-document' or 'delete-documents'. The description lacks context about prerequisites, consequences, or appropriate scenarios for mass deletion versus targeted operations.

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/OrionPotter/iflow-mcp_meilisearch-ts-mcp'

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