使用说明

项目简介

Contentful Delivery MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在为 AI 助手提供便捷的 Contentful 内容管理系统访问能力。通过该服务器,AI 助手可以使用自然语言查询和调用预定义的工具,轻松检索 Contentful 中的内容条目、资产和内容类型信息,从而实现更智能的内容交互和管理。

主要功能点

  • 自然语言内容查询: 支持使用自然语言关键词在 Contentful 内容中进行搜索。
  • 内容条目检索: 能够根据 ID 或内容类型检索特定的内容条目。
  • 资产管理: 提供浏览和检索 Contentful 资产的功能。
  • 内容类型 schema 访问: 允许访问 Contentful 内容类型的结构定义。
  • 分页支持: 支持分页获取大量内容条目和资产。
  • 富文本内容处理: 能够处理 Contentful 的富文本内容。
  • 提供丰富的工具: 内置了多个工具,方便 AI 助手进行各种内容操作,例如:
    • 'query_entries': 自然语言搜索内容条目
    • 'get_entry': 根据 ID 获取指定内容条目
    • 'get_entries': 列出内容条目,支持按内容类型过滤
    • 'get_assets': 浏览所有资产
    • 'get_asset': 根据 ID 获取指定资产
    • 'get_content_type': 查看内容类型 schema
    • 'get_content_types': 列出所有内容类型

安装步骤

  1. 安装 npm 包:

    npm install @mshaaban0/contentful-delivery-mcp-server

    或者全局安装:

    npm install -g @mshaaban0/contentful-delivery-mcp-server
  2. 配置 Contentful 凭据: 设置环境变量 'CONTENTFUL_SPACE_ID' 和 'CONTENTFUL_ACCESS_TOKEN' 为您的 Contentful Space ID 和访问令牌。

    export CONTENTFUL_SPACE_ID="your_space_id"
    export CONTENTFUL_ACCESS_TOKEN="your_access_token"

服务器配置

对于 MCP 客户端,需要配置服务器的启动命令和参数以建立连接。以下是该 Contentful Delivery MCP Server 的典型配置信息:

{
  "server": {
    "name": "contentful-delivery",
    "command": "npx",
    "args": ["-y", "@mshaaban0/contentful-delivery-mcp-server@latest"],
    "env": {
      "CONTENTFUL_ACCESS_TOKEN": "your_access_token", // 替换为您的 Contentful 访问令牌
      "CONTENTFUL_SPACE_ID": "your_space_id"      // 替换为您的 Contentful Space ID
    }
  }
}

参数说明:

  • 'command': 启动服务器的命令,这里使用 'npx' 来运行 npm 包。
  • 'args': 传递给 'npx' 的参数,'-y' 表示自动确认安装包,'@mshaaban0/contentful-delivery-mcp-server@latest' 指定要运行的 npm 包及其版本。
  • 'env': 设置服务器运行所需的环境变量,包括 'CONTENTFUL_ACCESS_TOKEN' 和 'CONTENTFUL_SPACE_ID',用于连接 Contentful API。

基本使用方法

  1. 启动 MCP 服务器: 如果全局安装,可以直接运行 'contentful-delivery-mcp-server' 命令启动服务器。如果本地安装,请参考 'README.md' 中的 Development 部分,使用 'npm run watch' 或 'npm run inspector' 启动服务器。

  2. 配置 MCP 客户端: 在您的 MCP 客户端 (例如 Mastra AI) 中,配置上述提供的服务器配置信息。客户端将使用这些信息连接到 Contentful Delivery MCP Server。

  3. 使用 AI 助手与 Contentful 内容交互: 通过 MCP 客户端,您可以指示 AI 助手使用注册的工具来查询和操作 Contentful 内容。例如,您可以向 AI 助手提问 "查找关于机器学习的文章" 或 "获取 ID 为 'example-entry-id' 的内容条目",AI 助手将自动调用相应的工具并返回结果。

信息

分类

生产力应用