facet-search
Filter and search specific facet values in Meilisearch indexes using defined criteria, enabling precise data retrieval and enhanced search functionality.
Instructions
Search for facet values matching specific criteria
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| facetName | Yes | Name of the facet to search | |
| facetQuery | No | Query to match against facet values | |
| filter | No | Filter to apply to the base search | |
| indexUid | Yes | Unique identifier of the index |
Implementation Reference
- src/tools/search-tools.ts:158-174 (handler)The async handler function that performs the 'facet-search' tool logic by constructing parameters and posting to the Meilisearch `/indexes/${indexUid}/facet-search` endpoint.async ({ indexUid, facetName, facetQuery, filter }) => { try { const params: Record<string, any> = { facetName, }; if (facetQuery !== undefined) params.facetQuery = facetQuery; if (filter) params.filter = filter; const response = await apiClient.post(`/indexes/${indexUid}/facet-search`, params); return { content: [{ type: 'text', text: JSON.stringify(response.data, null, 2) }], }; } catch (error) { return createErrorResponse(error); } }
- src/tools/search-tools.ts:152-157 (schema)Input schema using Zod for the 'facet-search' tool parameters.{ indexUid: z.string().describe('Unique identifier of the index'), facetName: z.string().describe('Name of the facet to search'), facetQuery: z.string().optional().describe('Query to match against facet values'), filter: z.string().optional().describe('Filter to apply to the base search'), },
- src/tools/search-tools.ts:149-175 (registration)The server.tool registration of the 'facet-search' tool, including description, schema, and handler.server.tool( 'facet-search', 'Search for facet values matching specific criteria', { indexUid: z.string().describe('Unique identifier of the index'), facetName: z.string().describe('Name of the facet to search'), facetQuery: z.string().optional().describe('Query to match against facet values'), filter: z.string().optional().describe('Filter to apply to the base search'), }, async ({ indexUid, facetName, facetQuery, filter }) => { try { const params: Record<string, any> = { facetName, }; if (facetQuery !== undefined) params.facetQuery = facetQuery; if (filter) params.filter = filter; const response = await apiClient.post(`/indexes/${indexUid}/facet-search`, params); return { content: [{ type: 'text', text: JSON.stringify(response.data, null, 2) }], }; } catch (error) { return createErrorResponse(error); } } );
- src/index.ts:66-66 (registration)Top-level call to registerSearchTools which registers the 'facet-search' tool among search tools.registerSearchTools(server);