search

Instructions

Implementation Reference

• src/tools/search-tools.ts:63-103 (handler)

  The asynchronous handler function for the 'search' MCP tool. It takes search parameters, makes a POST request to the Meilisearch `/indexes/${indexUid}/search` endpoint using apiClient, returns the JSON response or an error response.

  async ({ 
    indexUid, 
    q, 
    limit, 
    offset, 
    filter, 
    sort, 
    facets, 
    attributesToRetrieve, 
    attributesToCrop, 
    cropLength, 
    attributesToHighlight, 
    highlightPreTag, 
    highlightPostTag, 
    showMatchesPosition, 
    matchingStrategy 
  }: SearchParams) => {
    try {
      const response = await apiClient.post(`/indexes/${indexUid}/search`, {
        q,
        limit,
        offset,
        filter,
        sort,
        facets,
        attributesToRetrieve,
        attributesToCrop,
        cropLength,
        attributesToHighlight,
        highlightPreTag,
        highlightPostTag,
        showMatchesPosition,
        matchingStrategy,
      });
      return {
        content: [{ type: 'text', text: JSON.stringify(response.data, null, 2) }],
      };
    } catch (error) {
      return createErrorResponse(error);
    }
  }

• src/tools/search-tools.ts:47-62 (schema)

  Zod input schema defining parameters for the 'search' tool, including indexUid, q (query), limit, offset, filter, sort, facets, cropping options, highlighting options, etc.

    indexUid: z.string().describe('Unique identifier of the index'),
    q: z.string().describe('Search query'),
    limit: z.number().min(1).max(1000).optional().describe('Maximum number of results to return (default: 20)'),
    offset: z.number().min(0).optional().describe('Number of results to skip (default: 0)'),
    filter: z.string().optional().describe('Filter query to apply'),
    sort: z.array(z.string()).optional().describe('Attributes to sort by, e.g. ["price:asc"]'),
    facets: z.array(z.string()).optional().describe('Facets to return'),
    attributesToRetrieve: z.array(z.string()).optional().describe('Attributes to include in results'),
    attributesToCrop: z.array(z.string()).optional().describe('Attributes to crop'),
    cropLength: z.number().optional().describe('Length at which to crop cropped attributes'),
    attributesToHighlight: z.array(z.string()).optional().describe('Attributes to highlight'),
    highlightPreTag: z.string().optional().describe('Tag to insert before highlighted text'),
    highlightPostTag: z.string().optional().describe('Tag to insert after highlighted text'),
    showMatchesPosition: z.boolean().optional().describe('Whether to include match positions in results'),
    matchingStrategy: z.string().optional().describe("Matching strategy: 'all' or 'last'"),
  },

• src/tools/search-tools.ts:43-104 (registration)

  MCP server.tool() registration for the 'search' tool, specifying name 'search', description, input schema, and handler function.

  server.tool(
    'search',
    'Search for documents in a Meilisearch index',
    {
      indexUid: z.string().describe('Unique identifier of the index'),
      q: z.string().describe('Search query'),
      limit: z.number().min(1).max(1000).optional().describe('Maximum number of results to return (default: 20)'),
      offset: z.number().min(0).optional().describe('Number of results to skip (default: 0)'),
      filter: z.string().optional().describe('Filter query to apply'),
      sort: z.array(z.string()).optional().describe('Attributes to sort by, e.g. ["price:asc"]'),
      facets: z.array(z.string()).optional().describe('Facets to return'),
      attributesToRetrieve: z.array(z.string()).optional().describe('Attributes to include in results'),
      attributesToCrop: z.array(z.string()).optional().describe('Attributes to crop'),
      cropLength: z.number().optional().describe('Length at which to crop cropped attributes'),
      attributesToHighlight: z.array(z.string()).optional().describe('Attributes to highlight'),
      highlightPreTag: z.string().optional().describe('Tag to insert before highlighted text'),
      highlightPostTag: z.string().optional().describe('Tag to insert after highlighted text'),
      showMatchesPosition: z.boolean().optional().describe('Whether to include match positions in results'),
      matchingStrategy: z.string().optional().describe("Matching strategy: 'all' or 'last'"),
    },
    async ({ 
      indexUid, 
      q, 
      limit, 
      offset, 
      filter, 
      sort, 
      facets, 
      attributesToRetrieve, 
      attributesToCrop, 
      cropLength, 
      attributesToHighlight, 
      highlightPreTag, 
      highlightPostTag, 
      showMatchesPosition, 
      matchingStrategy 
    }: SearchParams) => {
      try {
        const response = await apiClient.post(`/indexes/${indexUid}/search`, {
          q,
          limit,
          offset,
          filter,
          sort,
          facets,
          attributesToRetrieve,
          attributesToCrop,
          cropLength,
          attributesToHighlight,
          highlightPreTag,
          highlightPostTag,
          showMatchesPosition,
          matchingStrategy,
        });
        return {
          content: [{ type: 'text', text: JSON.stringify(response.data, null, 2) }],
        };
      } catch (error) {
        return createErrorResponse(error);
      }
    }
  );

• src/tools/search-tools.ts:14-30 (schema)

  TypeScript interface SearchParams defining the types for search parameters used in the handler.

  interface SearchParams {
    indexUid: string;
    q: string;
    limit?: number;
    offset?: number;
    filter?: string;
    sort?: string[];
    facets?: string[];
    attributesToRetrieve?: string[];
    attributesToCrop?: string[];
    cropLength?: number;
    attributesToHighlight?: string[];
    highlightPreTag?: string;
    highlightPostTag?: string;
    showMatchesPosition?: boolean;
    matchingStrategy?: string;
  }

• src/index.ts:66-66 (registration)

  Call to registerSearchTools(server) in the main server initialization, which registers the 'search' tool among other search tools.

  registerSearchTools(server);