update-documents
Modify existing documents in a Meilisearch index by providing updated JSON data and specifying the target index and primary key.
Instructions
Update documents in a Meilisearch index
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| indexUid | Yes | Unique identifier of the index | |
| documents | Yes | JSON array of documents to update | |
| primaryKey | No | Primary key for the documents |
Implementation Reference
- src/tools/document-tools.ts:163-190 (handler)The async handler function for the 'update-documents' tool. Parses the input documents JSON string, validates it's an array, optionally sets primaryKey param, performs PUT request to Meilisearch /indexes/{indexUid}/documents endpoint, returns JSON response or formatted error.async ({ indexUid, documents, primaryKey }: UpdateDocumentsParams) => { try { // Parse the documents string to ensure it's valid JSON const parsedDocuments = JSON.parse(documents); // Ensure documents is an array if (!Array.isArray(parsedDocuments)) { return { isError: true, content: [{ type: 'text', text: 'Documents must be a JSON array' }], }; } const params: Record<string, string> = {}; if (primaryKey) { params.primaryKey = primaryKey; } const response = await apiClient.put(`/indexes/${indexUid}/documents`, parsedDocuments, { params, }); return { content: [{ type: 'text', text: JSON.stringify(response.data, null, 2) }], }; } catch (error) { return createErrorResponse(error); } }
- src/tools/document-tools.ts:158-162 (schema)Zod input schema defining parameters for the 'update-documents' tool: indexUid (required string), documents (required JSON string), primaryKey (optional string).{ indexUid: z.string().describe('Unique identifier of the index'), documents: z.string().describe('JSON array of documents to update'), primaryKey: z.string().optional().describe('Primary key for the documents'), },
- src/tools/document-tools.ts:155-191 (registration)MCP server.tool() registration call for 'update-documents' tool, including name, description, input schema, and inline handler function.server.tool( 'update-documents', 'Update documents in a Meilisearch index', { indexUid: z.string().describe('Unique identifier of the index'), documents: z.string().describe('JSON array of documents to update'), primaryKey: z.string().optional().describe('Primary key for the documents'), }, async ({ indexUid, documents, primaryKey }: UpdateDocumentsParams) => { try { // Parse the documents string to ensure it's valid JSON const parsedDocuments = JSON.parse(documents); // Ensure documents is an array if (!Array.isArray(parsedDocuments)) { return { isError: true, content: [{ type: 'text', text: 'Documents must be a JSON array' }], }; } const params: Record<string, string> = {}; if (primaryKey) { params.primaryKey = primaryKey; } const response = await apiClient.put(`/indexes/${indexUid}/documents`, parsedDocuments, { params, }); return { content: [{ type: 'text', text: JSON.stringify(response.data, null, 2) }], }; } catch (error) { return createErrorResponse(error); } } );
- src/tools/document-tools.ts:34-38 (schema)TypeScript interface defining typed parameters for the update-documents handler.interface UpdateDocumentsParams { indexUid: string; documents: string; primaryKey?: string; }
- src/index.ts:65-65 (registration)Top-level invocation of registerDocumentTools(server) in main server initialization, which registers the document tools including 'update-documents'.registerDocumentTools(server);