mcpField
C
cms-data-modeling-best-practices

cms-data-modeling-best-practices

github.com/contentstack数据与数据库598 次安装1 周前更新
代码仓库

关于 cms-data-modeling-best-practices

为 Contentstack 开发者提供内容模型设计、审查与重构建议，帮助选择合适的结构并兼顾编辑体验、复用和查询需求。该技能强调简化模型、减少引用层级，并提示迁移风险。

主要功能

  1. 01选择合适的内容建模结构
  2. 02审查复用与字段归属
  3. 03评估引用深度和查询影响
  4. 04提供本地化与治理建议
  5. 05指出反模式和迁移注意事项

适用场景

  1. 01设计含可复用区块的落地页模型
  2. 02判断字段组、全局字段或内容类型
  3. 03审查并简化现有内容模型
  4. 04规划共享内容的本地化方式

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/contentstack/contentstack-agent-skills --skill cms-data-modeling-best-practices

安装后在 Claude Code 中输入/cms-data-modeling-best-practices确认已加载。

详细介绍

Contentstack 内容建模最佳实践

描述

指导开发者使用最简单、可复用的结构在 Contentstack 中建模内容。本技能说明何时使用内容类型、引用、全局字段、组、模块化区块、JSON RTE、分类体系和标签，并帮助避免过度建模、引用链过深以及按渠道划分导致的架构膨胀。

适用场景

在创建或更改架构之前，设计、审查或重构 Contentstack 内容模型时使用。

用户问题

开发者需要一种实用方法来选择合适的 Contentstack 结构，使编辑人员能够高效工作、交付代码保持简单，并让架构具备可复用性、可治理性且易于查询。

成功标准

推荐最简单且有效的模型，清晰说明权衡，保证编辑体验，避免不必要的抽象，并使架构稳定、层次浅，同时满足本地化和治理需求。

预期输入

  • 业务目标或用例
  • 当前或拟议的模型
  • 目标渠道和交付需求
  • 本地化要求
  • 复用和治理要求
  • 示例内容或条目
  • 性能或查询限制

预期输出

  • 推荐的建模方法
  • 针对各类结构的指导
  • 权衡说明
  • 反模式警告
  • 本地化和治理建议
  • 查询和性能注意事项
  • 可选的示例模型或决策摘要
  • 架构变更可能涉及的迁移注意事项

用户请求示例

  • 如何在 Contentstack 中为包含可复用区块的着陆页建模？
  • 这类数据应该使用全局字段、组还是内容类型？
  • 请审查这个内容模型，并告诉我可以简化哪些部分。
  • 共享内容的本地化最好如何处理？
  • 如何为产品类别建模，以支持筛选和复用？

工作流摘要

  1. 确定领域概念、编辑工作流、交付渠道、本地化需求、复用要求和查询限制。
  2. 选择最合适且最简单的结构：内容类型、引用、全局字段、组、模块化区块、JSON RTE、分类体系、标签或普通字段。
  3. 仅在内容会独立变化或出现在多个条目中时，才优先采用可复用结构。
  4. 检查引用深度、API 合约稳定性和查询影响。
  5. 审查本地化和命名规范。
  6. 指出反模式并建议更简单的替代方案。
  7. 给出简洁的建议，并在需要时提醒迁移注意事项。

说明

了解目标

在建议更改之前，确定领域概念、编辑工作流、交付渠道、本地化需求、复用要求和查询限制。

选择合适的结构

选择最简单且适用的 Contentstack 结构：内容类型、引用、全局字段、组、模块化区块、JSON RTE、分类体系、标签或普通字段。

仅在合理时采用复用结构

当内容会独立变化或出现在多个条目中时，使用可复用且受治理的结构。由父级拥有的数据应保留为内联数据。

检查查询影响

将内容类型视为 API 合约。避免引用链过深、模块化区块过大，以及将可筛选的信息隐藏在富文本中。

审查本地化和治理

仅对需要翻译的字段进行本地化。保持名称清晰，并避免架构受到渠道特定内容的污染。

说明权衡

说明推荐选项为何更好、能避免哪些问题，以及可以减少哪些维护或查询成本。

给出实用的答复

提供简洁的建议，仅在有帮助时比较替代方案，并在架构变更可能涉及迁移时提醒注意事项。

快速决策规则

对于拥有独立生命周期的真实领域概念，使用内容类型。对于可复用且归属独立的内容，使用引用。对于多个内容类型中相同的嵌套字段集，使用全局字段。对于单个内容类型中由父级拥有的嵌套数据，使用组。对于页面本地组合，使用模块化区块。对于叙述性内容，使用 JSON RTE。对于受管理的分类，使用分类法。对于轻量级内部标签，使用标签。

输出格式

使用简洁、结构化且以指令为导向的文字。优先使用项目符号和简短章节。比较选项时，先说明推荐选择。相关时，说明反模式和迁移注意事项。不要暴露机密、API 密钥或管理令牌。

工具使用说明

只读咨询技能。优先使用默认 CMS 知识和文档来源。如果使用工具，请仅限于只读检查和文档查询。不要执行架构更改、发布或破坏性操作。

安全

默认规则
  • 切勿暴露管理令牌或 API 密钥。
  • 切勿要求用户将机密粘贴到提示词中。
  • 在任何示例代码中，使用环境变量存储凭据。
  • 在浏览器应用中，通过服务器端代理转发 CMA 调用。
  • 切勿在客户端代码中硬编码 stack API 密钥。
  • 不要推荐绕过治理或访问控制的不安全变通方案。
破坏性操作

不要执行破坏性操作。不要删除、发布、取消发布或修改 Contentstack 资源。仅提供指导。

机密

将所有凭据视为敏感信息。切勿请求或显示管理令牌、交付令牌、API 密钥或 Webhook 机密。仅使用占位符和环境变量。

环境变量

在任何需要凭据的示例或集成中，使用环境变量。优先使用 CONTENTSTACK_API_KEY、CONTENTSTACK_MANAGEMENT_TOKEN 和 CONTENTSTACK_DELIVERY_TOKEN 等占位符。切勿在示例或说明中硬编码机密。

产品背景

    • 产品：CMS
    • 说明：Contentstack 无头 CMS：内容类型、条目、资源、环境、发布、工作流、Webhook 和内容管理 API（CMA）。
    • 产品安全规则：- 切勿暴露管理令牌或 API 密钥。
  • 始终使用环境变量存储凭据。
  • 在浏览器应用中，通过服务器端代理转发所有 CMA 调用。
  • 切勿在客户端代码中硬编码 stack API 密钥。
    • 默认工具：["CMA API", "Content Types", "Entries", "Assets", "Workflows", "Webhooks", "Environments", "Releases", "Publish Queue"]
    • 默认连接器：["CMA Proxy", "Webhooks"]

评论

支持 Markdown