get-searchable-attributes
Retrieve the searchable attributes configuration for a Meilisearch index to understand which fields are indexed for search operations.
Instructions
Get the searchable attributes setting
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| indexUid | Yes | Unique identifier of the index |
Implementation Reference
- src/tools/settings-tools.ts:155-163 (handler)The handler function that executes the tool logic: fetches the searchable-attributes setting from the Meilisearch API for the given indexUid using the specific endpoint.
async ({ indexUid }) => { try { const response = await apiClient.get(`/indexes/${indexUid}/settings/${endpoint}`); return { content: [{ type: "text", text: JSON.stringify(response.data, null, 2) }], }; } catch (error) { return createErrorResponse(error); } - src/tools/settings-tools.ts:152-154 (schema)Input schema validation using Zod for the indexUid parameter.
{ indexUid: z.string().describe("Unique identifier of the index"), }, - src/tools/settings-tools.ts:90-94 (registration)Configuration object in the specificSettingsTools array that defines the name, endpoint, and description for the get-searchable-attributes tool.
{ name: "get-searchable-attributes", endpoint: "searchable-attributes", description: "Get the searchable attributes setting", }, - src/tools/settings-tools.ts:147-166 (registration)The forEach loop that dynamically registers the get-searchable-attributes tool (and others) with the MCP server using server.tool().
// Create a tool for each specific setting specificSettingsTools.forEach(({ name, endpoint, description }) => { server.tool( name, description, { indexUid: z.string().describe("Unique identifier of the index"), }, async ({ indexUid }) => { try { const response = await apiClient.get(`/indexes/${indexUid}/settings/${endpoint}`); return { content: [{ type: "text", text: JSON.stringify(response.data, null, 2) }], }; } catch (error) { return createErrorResponse(error); } } ); }); - src/index.ts:67-67 (registration)Top-level call to registerSettingsTools which includes the registration of get-searchable-attributes.
registerSettingsTools(server);