CMS API服务器

microCMS MCP服务器是一个基于Model Context Protocol (MCP)的API服务器,提供内容管理系统的数据访问和查询功能。

  • by burnworks
  • TypeScript
  • 本地部署
  • 更新于
在 GitHub 查看 burnworks/microcms-api-mcp-server

使用说明

microCMS MCP 服务器

此项目包括:模型上下文协议(MCP) 来修改标记元素的显示属性microCMS 的,之API 对较大场景进行渲染期间已观察到该故障。

概要

microCMS MCP 服务器提供以下功能:

  1. 获取内容列表:从指定端点获取内容列表
  2. 获取特定内容:ID 中描述的场景,使用以下步骤创建明细表,以便在概念设计中分析体量的体积
  3. 内容搜索:通过关键字检索获取内容
  4. 筛选器搜索:在复杂条件下过滤内容

安装

# リポジトリのクローン
git clone https://github.com/burnworks/microcms-api-mcp-server
cd microcms-api-mcp-server

# 依存関係のインストール
npm install

使用方法

构建所需文件

# TypeScriptをコンパイル
npm run build

dist/ 将在目录中生成所需的文件。

MCP 客户端使用

这个服务器MCP 符合协议的任何MCP 可以从客户端连接使用。

Claude 在桌面应用程序中使用

claude_desktop_config.json 中所述修改相应参数的值。

{
  "mcpServers": {
    "microcms": {
      "command": "node",
      "args": [
        "/[__path__]/microcms-api-mcp-server/dist/index.js"
      ],
      "env": {
        "MICROCMS_API_KEY": "__your_api_key_here__",
        "MICROCMS_BASE_URL": "https://your-service.microcms.io"
      }
    }
  }
}

Windows 如果是环境的话,可能会有以下的设定。

{
  "mcpServers": {
    "microcms": {
      "command": "C:/Program Files/nodejs/node.exe",
      "args": [
        "C:/[__path__]/microcms-api-mcp-server/dist/index.js"
      ],
      "env": {
        "MICROCMS_API_KEY": "__your_api_key_here__",
        "MICROCMS_BASE_URL": "https://your-service.microcms.io"
      }
    }
  }
}

可用工具

例如,在以下提示下microCMS API 中所述修改相应参数的值。

blog エンドポイントから、最新の記事10件分のタイトルを取得して

get_contents

获取内容列表。

参数:

  • endpoint:想要获取microCMS 的,之API 端点(例如'blog')
  • limit:获取的数量(可选,默认值:10,最大值:100)
  • offset:捕获起始位置偏移(可选)
  • orders:排序(可选,示例:'publishedAt' 或'-publishedAt')
  • q:全文搜索查询(可选)
  • filters:筛选条件(可选,示例:')title[contains]测试')
  • fields:检索字段(可选,示例:'id,title,publishedAt')
  • depth:参照深度(可选,1-3)

get_content

获取特定内容。

参数:

  • endpoint:想要获取microCMS 的,之API 端点(例如'blog')
  • contentId:要获取的内容ID
  • fields:检索字段(可选,示例:'id,title,publishedAt')
  • depth:参照深度(可选,1-3)
  • draftKey:获取草稿内容的键(可选)

search_contents

通过关键字搜索获取内容。

参数:

  • endpoint:查找microCMS 的,之API 端点(例如'blog')
  • q:搜索关键字
  • limit:获取的数量(可选,默认值:10,最大值:100)
  • offset:捕获起始位置偏移(可选)
  • fields:检索字段(可选,示例:'id,title,publishedAt')
  • depth:参照深度(可选,1-3)

filter_contents

在复杂条件下过滤内容。

参数:

  • endpoint:查找microCMS 的,之API 端点(例如'blog')
  • filters:筛选条件(例如'category[equals]news[and]createdAt[greater_than]2023-01-01')
  • limit:获取的数量(可选,默认值:10,最大值:100)
  • offset:捕获起始位置偏移(可选)
  • fields:检索字段(可选,示例:'id,title,publishedAt')
  • depth:参照深度(可选,1-3)

可用资源

microcms://{endpoint}/{contentId}

特定的ID 获取内容的资源URI 模板。

microcms://{endpoint}

用于获取内容列表的资源URI 模板。

许可证

麻省理工学院