Microcms MCP Server

🚀 microCMS MCP Server

microCMS API統合のためのモデルコンテキストプロトコル（MCP）サーバーです。このサーバーにより、ClaudeなどのAIアシスタントがmicroCMSコンテンツ管理システムとやり取りできるようになります。

microCMS

✨ 主な機能

• コンテンツ管理：microCMSのリスト型APIに対する完全なCRUD操作が可能です。
• 8つのコアツール：
  • microcms_get_list - フィルタリングとページネーションを使用してコンテンツリストを取得します。
  • microcms_get_content - 個々のコンテンツアイテムを取得します。
  • microcms_create_content - 新しいコンテンツを作成します。
  • microcms_update_content - コンテンツを更新します（PUT）。
  • microcms_patch_content - コンテンツを部分的に更新します（PATCH）。
  • microcms_delete_content - コンテンツを削除します。
  • microcms_get_media - メディアファイルを取得します（管理API）。
  • microcms_upload_media - メディアファイルをアップロードします（管理API）。
• 完全なAPIサポート：ドラフト、フィルター、ページネーション、深度展開など、すべてのmicroCMSクエリパラメータをサポートします。

📦 インストール

方法1: npxを使用する（推奨）

インストールは必要ありません！npxで直接使用できます。

npx microcms-mcp-server --service-id your-service-id --api-key your-api-key

方法2: グローバルインストール

npm install -g microcms-mcp-server
microcms-mcp-server --service-id your-service-id --api-key your-api-key

方法3: 開発環境のセットアップ

1. このリポジトリをクローンします。
2. 依存関係をインストールします。

   npm install
   

3. プロジェクトをビルドします。

   npm run build
   

設定

microCMSの資格情報は、2つの方法で設定できます。

方法1: 環境変数

1. 環境テンプレートをコピーします。

   cp .env.example .env
   

2. .envでmicroCMSの資格情報を設定します。

   MICROCMS_SERVICE_ID=your-service-id
   MICROCMS_API_KEY=your-api-key
   

方法2: コマンドライン引数

資格情報をコマンドライン引数として直接渡します。

node dist/index.js --service-id your-service-id --api-key your-api-key

注意：コマンドライン引数は環境変数よりも優先されます。

💻 使用例

サーバーの起動

環境変数を使用する場合：

npm start

コマンドライン引数を使用する場合：

npm run start:args
# または直接
node dist/index.js --service-id your-service-id --api-key your-api-key

Claude Desktopでの使用

Claude DesktopのMCP設定ファイルに以下を追加します。 macOS: ~/Library/Application Support/Claude/claude_desktop_config.json Windows: %APPDATA%/Claude/claude_desktop_config.json

オプション1: npxを使用する（推奨）

{
  "mcpServers": {
    "microcms": {
      "command": "npx",
      "args": [
        "-y",
        "microcms-mcp-server",
        "--service-id", "your-service-id",
        "--api-key", "your-api-key"
      ]
    }
  }
}

オプション2: グローバルインストールを使用する

{
  "mcpServers": {
    "microcms": {
      "command": "microcms-mcp-server",
      "args": [
        "--service-id", "your-service-id",
        "--api-key", "your-api-key"
      ]
    }
  }
}

オプション3: ローカル開発環境を使用する

{
  "mcpServers": {
    "microcms": {
      "command": "node",
      "args": [
        "/path/to/microcms-mcp-server/dist/index.js",
        "--service-id", "your-service-id",
        "--api-key", "your-api-key"
      ]
    }
  }
}

以下を置き換えます。

• your-service-id をあなたのmicroCMSサービスIDに置き換えます。
• your-api-key をあなたのmicroCMS APIキーに置き換えます。
• /path/to/microcms-mcp-server/ を実際のパスに置き換えます（オプション3のみ）。

設定を更新した後、Claude Desktopを再起動します。

開発モード

npm run dev

利用可能なスクリプト

• npm run build - TypeScriptをJavaScriptにビルドします。
• npm start - コンパイルされたサーバーを実行します。
• npm run dev - 自動リロードを備えた開発モードです。
• npm run lint - ESLintを実行します。
• npm run format - Prettierでコードを整形します。

基本的な使用法

コンテンツリストの取得

{
  "name": "microcms_get_list",
  "arguments": {
    "endpoint": "blogs",
    "limit": 10,
    "orders": "-publishedAt"
  }
}

個々のコンテンツの取得

{
  "name": "microcms_get_content",
  "arguments": {
    "endpoint": "blogs",
    "contentId": "article-1"
  }
}

新しいコンテンツの作成

{
  "name": "microcms_create_content",
  "arguments": {
    "endpoint": "blogs",
    "content": {
      "title": "My Blog Post",
      "body": "Content here...",
      "category": "tech",
      "thumbnail": "https://example.com/image.jpg"
    }
  }
}

画像付きでコンテンツを更新する

{
  "name": "microcms_update_content",
  "arguments": {
    "endpoint": "blogs",
    "contentId": "article-1",
    "content": {
      "title": "Updated Title",
      "image": "https://example.com/new-image.jpg"
    }
  }
}

メディアファイルの取得

{
  "name": "microcms_get_media",
  "arguments": {
    "limit": 20,
    "imageOnly": true,
    "fileName": "sample"
  }
}

メディアファイルのアップロード（Base64）

{
  "name": "microcms_upload_media",
  "arguments": {
    "fileData": "base64-encoded-file-data",
    "fileName": "image.jpg",
    "mimeType": "image/jpeg"
  }
}

メディアファイルのアップロード（外部URL）

{
  "name": "microcms_upload_media",
  "arguments": {
    "externalUrl": "https://example.com/image.jpg"
  }
}

フィールドタイプの仕様

コンテンツを作成または更新する際、異なるフィールドタイプには特定の形式が必要です。

テキストフィールド

"title": "Article Title"

リッチエディターフィールド

"body": "<h1>見出し</h1><p>このようにHTMLで入稿できます</p>"

画像フィールド

同じmicroCMSサービスのURLを使用する必要があります。

"thumbnail": "https://images.microcms-assets.io/assets/xxxxxxxx/yyyyyyyy/sample.png"

複数の画像フィールド

"gallery": [
  "https://images.microcms-assets.io/assets/xxxxxxxx/yyyyyyyy/sample1.png",
  "https://images.microcms-assets.io/assets/xxxxxxxx/yyyyyyyy/sample2.png"
]

日付フィールド

ISO 8601形式を使用します。

"publishedAt": "2020-04-23T14:32:38.163Z"

セレクトフィールド

"categories": ["カテゴリ1", "カテゴリ2"]

コンテンツ参照フィールド

単一の参照

"relatedArticle": "article-id-123"

複数の参照

"relatedArticles": ["article-id-123", "article-id-456"]

完全な例

{
  "name": "microcms_create_content",
  "arguments": {
    "endpoint": "blogs",
    "content": {
      "title": "My Blog Post",
      "body": "<h2>Introduction</h2><p>This is a paragraph with <strong>bold text</strong>.</p>",
      "thumbnail": "https://images.microcms-assets.io/assets/xxx/yyy/image.png",
      "publishedAt": "2024-01-15T10:30:00.000Z",
      "categories": ["tech", "tutorial"],
      "relatedArticles": ["article-1", "article-2"]
    }
  }
}

メディア管理

メディアの取得 (microcms_get_media)

• APIタイプ：管理API v2（直接フェッチ）
• 権限：「メディアの取得」権限が必要です。
• 機能：
  • トークンによるページネーション（15秒の有効期限）
  • ファイル名でのフィルタリング
  • 画像のみのフィルタリング
  • URL、寸法、およびメタデータを返します。

メディアのアップロード (microcms_upload_media)

• APIタイプ：管理API v1（JS SDK経由）
• 権限：「メディアのアップロード」権限が必要です。
• アップロード方法：
  1. ファイルデータのアップロード：ファイル名とmimeTypeを含むBase64エンコードされたファイルデータ。
  2. 外部URLのアップロード：外部URLからの直接アップロード。
• 制限事項：
  • ファイルサイズ：最大5MB
  • リクエストごとに1つのファイル
  • チーム、ビジネス、アドバンスト、エンタープライズプランで利用可能。
• 返却値：microCMSアセットのURL
  • 画像：https://images.microcms-assets.io/...
  • ファイル：https://files.microcms-assets.io/...

📚 ドキュメント

すべてのツールは、完全な範囲のmicroCMS APIパラメータをサポートしています。コンテンツツールはコンテンツAPIを使用し、メディアツールは管理APIを使用します。

🔧 技術詳細

サーバーは、以下のエラーに対して詳細なエラーメッセージを提供します。

• 必要な環境変数が欠落している場合
• 無効なAPIリクエストの場合
• microCMS APIエラーの場合
• ツールパラメータが不正な場合

📄 ライセンス

MIT