microCMS
Documentation
  • Pricing
  • Blog
  • FAQ
  • Contact
  • Sign In
  • Get started for free
Navigation
Tutorial
Next.js
  • Integration with Next.js
  • Getting Started with App Router
  • Tutorial (App Router)
  • Getting Started with Pages Router
  • Tutorial (Pages Router)
Astro
  • Getting Started
  • Integration with Astro
  • Tutorial
Nuxt
  • Integration with Nuxt
  • Getting Started
  • Tutorial
Gatsby
  • Integration with Gatsby
  • Getting Started
  • Tutorial
JavaScript
  • Integration with JavaScript
  • Getting Started (Browser)
  • Getting Started (Server)
PHP
  • Integration with PHP
  • Getting Started
Ruby
  • Integration with Ruby
  • Getting Started
Go
  • Integration with Go
  • Getting Started with microCMS
Manual
  • Introduction
Account & Login
  • Account Registration
  • Login
  • Email Address Authentication
Services
  • Creating a Service
  • Service Configuration
  • Template
  • Service Deletion
Payment
  • Change of Pricing Plan
  • Registering and Changing Payment Methods
API
  • Creating and Managing APIs
  • API Settings
  • Export/Import of API Schema
Fields
  • Text Field
  • Text Area
  • Image
  • Multiple Images
  • Date
  • Boolean
  • Selectable Field
  • Content Reference
  • Multiple Content References
  • Number
  • File
  • Extended Field
  • Repetition
  • Custom
Contents
  • CSV Export of Content
  • Content Creation
  • Content Editing
  • Content Management
  • View
  • Content Status
  • Custom Status
  • Setting the Content ID
  • Automatically Assigned Values for Content
  • CSV Import of Content
  • API Preview
  • Examples of Using Query Parameters with API Preview
  • Integration Methods by Rendering Type
  • Screen Preview
  • Setting Up Webhooks for Content
Rich Editor
  • How to Use the Rich Editor
  • Rich Editor WRITE API
  • How to Use the Old Rich Editor
Reviews
  • Review
  • AI Review
Media
  • Media Management
  • Changing Media Filters and Display Order
  • Media Tag Configuration
  • Setting Up Media Webhooks
  • Custom Domain Settings for Media
Permission Management
  • Member Management
  • Roles (Permission Management in the Admin Panel)
Environments
  • Multiple Environments (Development Environment)
  • Merging API Settings Between Environments
Connection
  • Amazon S3 Integration
Logs
  • Audit Log
  • Data Transfer Volume
Security
  • Content Update History
  • IP Restrictions for Management Dashboard
  • IP Restrictions for APIs
Authentication
  • Setting Up Two-Factor Authentication
  • Mandatory Two-Factor Authentication
  • Single Sign-On
Specifications & Limitations
  • Recommended Environment
  • Limitations / Precautions
Content API
  • What is the Content API?
Basic Operations
  • GET /api/v1/{endpoint}
  • GET /api/v1/{endpoint}/{content_id}
  • POST /api/v1/{endpoint}
  • PUT /api/v1/{endpoint}/{content_id}
  • PATCH /api/v1/{endpoint}/{content_id}
  • DELETE /api/v1/{endpoint}/{content_id}
API Keys
  • API Key (API Authentication and Authorization Management)
  • Migration from the Old API (X-API-KEY, etc.)
Responses & Error Handling
  • Response format for each field in the GET API
  • Specifying Query Parameters in the GET API
  • Error Responses of the Content API
Management API (Beta)
  • What is the Management API?
Content Operations
  • PUT /api/v1/contents/{endpoint}/{content_id}/reservation
  • GET /api/v1/contents/{endpoint}
  • GET /api/v1/contents/{endpoint}/{content_id}
  • PATCH /api/v1/contents/{endpoint}/{content_id}/status
  • PATCH /api/v1/contents/{endpoint}/{content_id}/createdBy
Media Operations
  • GET /api/v2/media
  • GET /api/v1/media
  • POST /api/v1/media
  • DELETE /api/v2/media
Member Operations
  • GET /api/v1/members
  • GET /api/v1/members/{member_id}
API Operations
  • POST /api/v1/apis
  • GET /api/v1/apis
  • GET /api/v1/apis/{endpoint}
Service Operations
  • GET /api/v1/service
Responses & Error Handling
  • Management API Error Responses
Image API
  • What is the Image API?
Parameters
  • Image Size
  • Quality
  • Resolution and Screen Size
  • Format
  • Text
  • Border
  • Padding
  • Shape
  • Download
  • Watermark
MCP Server
  • microCMS MCP
  • microCMS Document MCP Server
  • Top
  • MCP Server

microCMS MCP

Last updated: 2026/10/26
Information

This feature is currently offered in beta. Specifications and provided content may change.

By using microCMS MCP, you can retrieve and manipulate microCMS content and service information using natural language from AI that supports the Model Context Protocol (MCP).
Since microCMS hosts the MCP server, users do not need to start an MCP server in their local environment. You can use it by setting the service connection URL and API Key in the MCP client.

Available Tools

This section lists the tools available in microCMS MCP (units of provided functions and operations) along with the corresponding APIs for each tool.
The available tools are subject to the permissions of the configured API Key. To use tools that perform write operations, an API Key with the necessary permissions for the target operations is required.

Tool Name

API Type

API

microcms_get_list

Content API

Get Contents List

microcms_get_content

Get Content Details

microcms_create_content_published

Create Content (Published)

microcms_create_contents_bulk_published

microcms_create_content_draft

Create Content (Draft)

microcms_create_contents_bulk_draft

microcms_update_content

Update Content (Update Published Content)

microcms_update_content_draft_only

Update Content (Update Draft Content Only)

microcms_delete_content

Delete Content

microcms_get_list_meta

Management API

Get Contents List

microcms_get_content_meta

Get Content Details

microcms_patch_content_status

Change Content Publication Status

microcms_patch_content_created_by

Change Content Creator

microcms_update_content_reservation

Change Content Reservation Settings

microcms_get_media

Get Media

microcms_upload_media

Upload Media

microcms_delete_media

Delete Media

microcms_get_api_list

Get API Information List

microcms_get_api_info

Get API Information Details

microcms_create_api

Create API

microcms_get_member

Get Member Details

microcms_get_members

Get Members List

Settings

Authentication Method

microCMS MCP uses HTTP Bearer authentication with an API Key. OAuth authentication is not supported at this time.

microCMS Configuration

Obtain the Service ID and API Key for the service you will use with microCMS MCP.
Please grant the necessary permissions to the API Key to execute the APIs corresponding to the tools you wish to use. For detailed configuration instructions, please refer to "API Key (API Authentication and Permission Management)".

MCP Client-Side Settings

Here, we will introduce some examples of settings for various clients.

Information

The settings, screen layout, and menu names for the MCP client may change. If the steps on this page differ, please also refer to the official documentation for each client.

ChatGPT (Web)

  1. Open the settings in the web version of ChatGPT.
  2. Go to [Security and Login] and turn on [Developer Mode].
  3. Return to the home screen and select [Plugins] from the left sidebar.
  4. Click the [+] button in the upper right corner of the screen.
  5. Enter the following and click the [Create] button to connect. Replace ${MICROCMS_SERVICE_ID} and ${MICROCMS_API_KEY} with your own Service ID and API Key. (The access token will be entered on the screen after creation.)

Item

Setting Value

Icon

Optional

Name

Optional

Connection (Server URL)

https://mcp.microcms.io/mcp/${MICROCMS_SERVICE_ID}

Authentication

Access Token or API Key

Header Scheme

Custom Header

Header Name

Authorization

Access Token or API Key

Bearer ${MICROCMS_API_KEY}

Information

To use the custom MCP with ChatGPT, a paid plan such as Plus, Pro, Business, Enterprise, or Edu is required.
Additionally, you must be an administrator or owner to enable developer mode.

ChatGPT (App)

  1. Open the settings in the ChatGPT app.
  2. Open Plugins and select the MCP tab.
  3. Select [Add MCP Server] from the Add menu.
  4. Choose [Streaming HTTP] as the connection method.
  5. Enter the following and save. Replace ${MICROCMS_SERVICE_ID} and ${MICROCMS_API_KEY} with your own Service ID and API Key.

Item

Setting Value

Name

Optional

URL

https://mcp.microcms.io/mcp/${MICROCMS_SERVICE_ID}

Header Key

Authorization

Header Value

Bearer ${MICROCMS_API_KEY}

Codex

Add the following to ~/.codex/config.toml. Replace ${MICROCMS_SERVICE_ID} and ${MICROCMS_API_KEY} with your own Service ID and API Key.

[mcp_servers.microcms]
url = "https://mcp.microcms.io/mcp/${MICROCMS_SERVICE_ID}"
http_headers = { Authorization = "Bearer ${MICROCMS_API_KEY}" }

Claude Desktop / Claude.ai

  1. Open the settings and select [Connectors].
  2. Select [Add] and then [Add Custom Connector].
  3. Enter the following and save. Replace ${MICROCMS_SERVICE_ID} and ${MICROCMS_API_KEY} with your own Service ID and API Key.

Item

Setting Value

Name

Optional

Remote MCP Server URL

https://mcp.microcms.io/mcp/${MICROCMS_SERVICE_ID}

Authentication

None

※ If using API Key authentication, select "None" and add the API Key to the request headers.

Request Header

authorization

Request Header Value

Bearer ${MICROCMS_API_KEY}

Information

- In Claude's Free plan, you may not be able to set Custom Request Headers, which could lead to integration issues.
- In Claude's Team plan or Enterprise plan, permissions of the Primary Owner/Owner are required to add a Custom MCP.

Claude Code

Run the following command. Replace ${MICROCMS_SERVICE_ID} and ${MICROCMS_API_KEY} with your own Service ID and API Key.

claude mcp add --transport http microcms \
  https://mcp.microcms.io/mcp/${MICROCMS_SERVICE_ID} \
  --header "Authorization: Bearer ${MICROCMS_API_KEY}"

Cursor

Add the following to ~/.cursor/mcp.json. Replace ${MICROCMS_SERVICE_ID} and ${MICROCMS_API_KEY} with your own Service ID and API Key.

{
  "mcpServers": {
    "microcms": {
      "url": "https://mcp.microcms.io/mcp/${MICROCMS_SERVICE_ID}",
      "headers": {
        "Authorization": "Bearer ${MICROCMS_API_KEY}"
      }
    }
  }
}

Notion Custom Agent

  1. Open the target custom agent.
  2. Go to Settings and open Tools & Access.
  3. Select [Add Connection] and then [Add Custom MCP].
  4. Enter the following and click [Connect]. Replace ${MICROCMS_SERVICE_ID} and ${MICROCMS_API_KEY} with your own Service ID and API Key.

Item

Setting Value

MCP Server URL

https://mcp.microcms.io/mcp/${MICROCMS_SERVICE_ID}

Name

Optional

Authentication

Bearer token

Prefix

Bearer

Token

${MICROCMS_API_KEY}

Information

To use a custom MCP with the Notion custom agent, a Notion Business plan or Enterprise plan is required.

Permission Settings for Safe Use

In microCMS MCP, to prevent unintended operations, it is recommended to limit the allowed actions to the bare minimum through two layers: the permissions of the API Key on the microCMS side and the tools enabled on the MCP client side.

1. Restrict API Key Permissions

When using microCMS MCP, it is recommended to create a dedicated API Key for AI operations, separate from the API Key used in production environments.
The actions that can be executed in microCMS MCP are governed by the permissions of the configured API Key. Please grant only the necessary permissions for the intended use to the AI operation-specific API Key.

2. Limit Tools Used in the MCP Client

If the MCP client allows enabling or disabling tools individually, please restrict the tools available to AI to only those that are necessary.
For example, if only content retrieval is to be performed, use an API Key that has only the permissions required for retrieval, and disable tools related to creation, updating, and deletion on the MCP client side.

By restricting the actions that can be executed in microCMS MCP with the API Key and limiting the tools available to AI on the MCP client side, you can use microCMS MCP with the minimum necessary permissions.

Notes

  • Uploading media may take time or may not complete successfully depending on how the MCP client processes file data.
  • API requests via microCMS MCP are sent from the MCP server hosted by microCMS. Since the source IP address is not fixed, it may not be usable for services that have API IP Restriction set.
  • When manipulating content via microCMS MCP, it is treated as an operation through the API.
  • For information on the MCP server used in a local environment, please refer to the GitHub repository.

Contents

  • Available Tools
  • Settings
  • Authentication Method
  • microCMS Configuration
  • MCP Client-Side Settings
  • Permission Settings for Safe Use
  • Notes
  • Company
  • Legal Notice
  • Terms of Service
  • Privacy Policy

Copyright © microcms.io All rights reserved.