get-index
Retrieve configuration and metadata for a specific Meilisearch index to manage search functionality and document organization.
Instructions
Get information about a specific Meilisearch index
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| indexUid | Yes | Unique identifier of the index |
Implementation Reference
- src/tools/index-tools.ts:79-88 (handler)Handler function for the 'get-index' tool. Fetches specific index information from Meilisearch API using the provided indexUid and returns formatted JSON response or error.async ({ indexUid }: GetIndexParams) => { try { const response = await apiClient.get(`/indexes/${indexUid}`); return { content: [{ type: 'text', text: JSON.stringify(response.data, null, 2) }], }; } catch (error) { return createErrorResponse(error); } }
- src/tools/index-tools.ts:19-21 (schema)TypeScript interface defining the input parameters for the get-index tool.interface GetIndexParams { indexUid: string; }
- src/tools/index-tools.ts:77-78 (schema)Zod schema for input validation of the get-index tool.indexUid: z.string().describe('Unique identifier of the index'), },
- src/tools/index-tools.ts:73-89 (registration)Direct registration of the 'get-index' tool within the registerIndexTools function using server.tool().server.tool( 'get-index', 'Get information about a specific Meilisearch index', { indexUid: z.string().describe('Unique identifier of the index'), }, async ({ indexUid }: GetIndexParams) => { try { const response = await apiClient.get(`/indexes/${indexUid}`); return { content: [{ type: 'text', text: JSON.stringify(response.data, null, 2) }], }; } catch (error) { return createErrorResponse(error); } } );
- src/index.ts:64-64 (registration)Top-level registration call that invokes registerIndexTools to add index tools, including 'get-index', to the main MCP server instance.registerIndexTools(server);