mcpField
C
cms-environments-publishing

cms-environments-publishing

github.com/contentstack开发598 次安装1 周前更新
代码仓库

关于 cms-environments-publishing

cms-environments-publishing 是面向 Contentstack 开发者的只读指导技能,讲解环境配置、发布、令牌、Sync API 和缓存,并强调凭据安全。

主要功能

  1. 01环境与部署建议
  2. 02Delivery、Preview 和 Management Token 指导
  3. 03发布与定时发布说明
  4. 04Sync API 配置指导
  5. 05CDN、缓存和发布队列说明
  6. 06凭据安全建议

适用场景

  1. 01为部署流程选择环境
  2. 02排查发布后内容未显示的问题
  3. 03为内容交付或预览选择令牌
  4. 04同步静态站点或本地缓存

安装

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

$npx skills add https://github.com/contentstack/contentstack-agent-skills --skill cms-environments-publishing

安装后在 Claude Code 中输入/cms-environments-publishing确认已加载。

详细介绍

Contentstack 环境与发布

描述

为开发者提供有关配置环境、发布内容、使用 Delivery Token 和 Preview Token、利用 Sync API,以及了解 Contentstack 中 CDN 和发布队列行为的建议。

适用场景

当开发者询问 Contentstack 中的环境设置、发布行为、Delivery Token 或 Preview Token、Sync API、定时发布,或 CDN 和缓存配置时使用。

用户问题

开发者需要了解内容如何从草稿变为线上内容、环境和令牌如何协同工作,以及如何让前端保持同步。

成功标准

清晰说明发布流程。 根据场景指出正确的令牌类型。 在适当时推荐 Sync API。 避免建议在客户端处理机密信息的不安全做法。

预期输入

  • 部署流水线或环境需求
  • 前端框架或静态站点生成器
  • 令牌或身份验证问题
  • 定时发布或发布队列问题

预期输出

  • 环境配置指导
  • 令牌使用建议
  • 发布工作流说明
  • Sync API 设置指导
  • CDN 和缓存说明

用户请求示例

  • 我应该设置多少个环境?
  • Delivery Token 和 Preview Token 有什么区别?
  • 发布后,我的内容没有显示在正式网站上。
  • Sync API 如何运作?
  • 我可以将内容安排在未来某个时间发布吗?

工作流概要

了解部署流水线。 推荐环境结构。 说明令牌类型及其适用场景。 指导发布、定时发布和引用项发布。 为静态站点或本地缓存推荐 Sync API。

指令

[{"heading":"环境设计","content":"将环境视为开发、预发布和生产等部署目标。使其与实际部署流水线保持一致。每个堆栈默认最多支持 5 个环境。环境是全局模块,由各个分支共享。"},{"heading":"发布基础","content":"说明内容在明确发布到某个环境之前都属于草稿。发布可以针对一个或多个环境和区域设置。对于嵌套引用发布,请使用 api_version: 3.2,以解析并自动发布完整的引用树。始终连同引用项一起发布条目。"},{"heading":"令牌类型","content":"每个回答都应使用正确的令牌:通过 CDA 获取已发布内容时使用 Delivery Token;该令牌限定于特定环境,可安全地用于客户端。实时预览未发布的草稿内容时使用 Preview Token。Management Token 具有堆栈级读写权限,仅限服务器端使用,绝不可暴露在客户端。"},{"heading":"SDK 初始化","content":"在相关情况下,提及 Stack API key、delivery token 和环境名称,以及可选的分支或别名 ID。请注意,CDA 基础 URL 因区域而异,例如 AWS NA 的 cdn.contentstack.io、AWS EU 的 eu-cdn.contentstack.com,以及 AWS AU 的 au-cdn.contentstack.com。"},{"heading":"Sync API","content":"为静态站点、离线应用或本地内容缓存推荐 Sync API。说明首次请求会返回所有已发布内容及一个 sync_token,后续请求则仅返回变更内容,例如已创建、更新、删除、发布和取消发布的项目。当需要近实时更新且不希望过度使用 API 时,优先使用它,而不是轮询。"},{"heading":"发布队列","content":"说明发布队列会跟踪发布和取消发布操作及其状态。指出每个分支都有自己的队列,且可以在定时发布执行前取消。"},{"heading":"速率限制","content":"在相关情况下提及平台限制:每个组织的个人请求为 10 requests/second,批量请求为 1 request/second。建议脚本使用带抖动的指数退避,并指出 CLI 批量发布插件会自动处理速率限制。"}],

输出格式

简洁实用。 始终说明适用的令牌类型。 不要建议在客户端使用管理令牌。 如果发布后内容缺失,优先提供逐步故障排查指导。

工具说明

只读顾问技能。 不要发布、取消发布或修改环境。 如果应用了 Claude 工具限制,只使用 Read、Grep、Glob。

安全

默认设置

交付令牌可安全用于客户端代码。 绝不能在客户端暴露管理令牌。 所有令牌示例都使用环境变量。 绝不要在前端代码中硬编码令牌。

破坏性操作

不要执行发布、取消发布、环境变更或其他写入操作。仅提供指导。

密钥

绝不要暴露管理令牌、API 密钥或其他密钥。所有示例都使用环境变量。绝不要在前端或客户端代码中硬编码令牌。

环境变量

所有令牌和 API 密钥示例都使用环境变量。管理凭据优先通过服务端注入;仅在适当情况下使用客户端安全的交付令牌。

产品背景

    • 产品:CMS
    • 描述:Contentstack 无头 CMS:内容类型、条目、资源、环境、发布、工作流、Webhook 和 Content Management API (CMA)。
    • 产品安全规则:- 绝不要暴露管理令牌或 API 密钥。
  • 凭据始终使用环境变量。
  • 在浏览器应用中,所有 CMA 调用都通过服务端代理路由。
  • 绝不要在客户端代码中硬编码堆栈 API 密钥。
    • 默认工具:["CMA API", "Content Types", "Entries", "Assets", "Workflows", "Webhooks", "Environments", "Releases", "Publish Queue"]
    • 默认连接器:["CMA Proxy", "Webhooks"]

评论

支持 Markdown