microcms_patch_content
Update existing content in microCMS with partial data modifications. Use this tool to edit specific fields while maintaining existing content structure.
Instructions
Create new content in microCMS and publish it immediately.
Important
Ensure that the "content" you submit strictly adheres to the following specifications. In particular, take extra care when handling custom fields and iframe fields, as mistakes are common in their structure. Read the instructions thoroughly and construct the data precisely as described. In particular, for extended fields (iframe fields), you need to take care to call microcms_get_list tool beforehand, and set its structure to the "data" field (Detail is described below).
Field type specifications
Image fields require URL string uploaded to microCMS media library (e.g., "https://images.microcms-assets.io/assets/xxx/yyy/sample.png").
Multiple image fields use array format.
Rich editor fields expect HTML strings.
Date fields use ISO 8601 format.
Select fields use arrays.
Content reference fields use contentId strings or arrays for multiple references, and you can get contentIds from microcms_get_list tool.
Custom field exepect below struct:
<field Id in apiFields> {
"fieldId": "<target custom field id in customFields>"
"key1": "<value1>",
"key2": "<value2>",
}iframe field (Extension field) expects the following structure for CREATE/UPDATE:
{
"id": "some-id",
"title": "some-title",
"description": "some-description",
"imageUrl": "https://images.microcms-assets.io/assets/xxxx/yyyy/{fileName}.png",
"updatedAt": "2024-01-01T00:00:00Z",
"data": { "key1": "value1", "key2": "value2" }
}IMPORTANT: When retrieving content via API, only the "data" object content is returned (without the wrapper).
IMPORTANT: When creating/updating content, you MUST provide the full structure including id, title, description, imageUrl, updatedAt, and data.
To understand the "data" structure, ALWAYS use microcms_get_list to retrieve existing content first and examine the field structure.
"id", "title", "description", "imageUrl" are metadata displayed in the admin screen and are not included in the API GET response.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| endpoint | Yes | Content type name (e.g., "blogs", "news") | |
| contentId | Yes | Content ID to update | |
| content | Yes | Partial content data to update (JSON object). Create new content in microCMS and publish it immediately. ## Important Ensure that the "content" you submit strictly adheres to the following specifications. In particular, take extra care when handling custom fields and iframe fields, as mistakes are common in their structure. Read the instructions thoroughly and construct the data precisely as described. In particular, for extended fields (iframe fields), you need to take care to call microcms_get_list tool beforehand, and set its structure to the "data" field (Detail is described below). ## Field type specifications * Image fields require URL string uploaded to microCMS media library (e.g., "https://images.microcms-assets.io/assets/xxx/yyy/sample.png"). * Multiple image fields use array format. * Rich editor fields expect HTML strings. * Date fields use ISO 8601 format. * Select fields use arrays. * Content reference fields use contentId strings or arrays for multiple references, and you can get contentIds from microcms_get_list tool. * Custom field exepect below struct: ```json <field Id in apiFields> { "fieldId": "<target custom field id in customFields>" "key1": "<value1>", "key2": "<value2>", } ``` * iframe field (Extension field) expects the following structure for CREATE/UPDATE: ```json { "id": "some-id", "title": "some-title", "description": "some-description", "imageUrl": "https://images.microcms-assets.io/assets/xxxx/yyyy/{fileName}.png", "updatedAt": "2024-01-01T00:00:00Z", "data": { "key1": "value1", "key2": "value2" } } ``` * **IMPORTANT**: When retrieving content via API, only the "data" object content is returned (without the wrapper). * **IMPORTANT**: When creating/updating content, you MUST provide the full structure including id, title, description, imageUrl, updatedAt, and data. * To understand the "data" structure, ALWAYS use microcms_get_list to retrieve existing content first and examine the field structure. * "id", "title", "description", "imageUrl" are metadata displayed in the admin screen and are not included in the API GET response. | |
| isDraft | No | Save as draft |
Implementation Reference
- src/tools/patch-content.ts:33-49 (handler)The handler function `handlePatchContent` that implements the core logic for the `microcms_patch_content` tool. Validates required parameters and invokes the underlying patch API via the imported `patch` function.
export async function handlePatchContent(params: ToolParameters) { const { endpoint, contentId, content, ...options } = params; if (!contentId) { throw new Error('contentId is required'); } if (!content) { throw new Error('content is required'); } const updateOptions: MicroCMSUpdateOptions = {}; if (options.isDraft !== undefined) updateOptions.isDraft = options.isDraft; return await patch(endpoint, contentId, content, updateOptions); } - src/tools/patch-content.ts:6-31 (schema)Defines the `patchContentTool` object with name, description, and detailed inputSchema for the `microcms_patch_content` tool.
export const patchContentTool: Tool = { name: 'microcms_patch_content', description: FIELD_FORMATS_DESCRIPTION, inputSchema: { type: 'object', properties: { endpoint: { type: 'string', description: 'Content type name (e.g., "blogs", "news")', }, contentId: { type: 'string', description: 'Content ID to update', }, content: { type: 'object', description: `Partial content data to update (JSON object). ` + FIELD_FORMATS_DESCRIPTION, }, isDraft: { type: 'boolean', description: 'Save as draft', }, }, required: ['endpoint', 'contentId', 'content'], }, }; - src/server.ts:16-16 (registration)Imports the tool definition (`patchContentTool`) and handler (`handlePatchContent`) for `microcms_patch_content`.
import { patchContentTool, handlePatchContent } from './tools/patch-content.js'; - src/server.ts:60-60 (registration)Registers `patchContentTool` in the server's list of available tools returned by ListToolsRequest.
patchContentTool, - src/server.ts:112-114 (registration)Switch case in CallToolRequest handler that dispatches execution to `handlePatchContent` for `microcms_patch_content`.
case 'microcms_patch_content': result = await handlePatchContent(params); break;