catalyst-basics

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese
⚠️ PRE-FLIGHT CHECK: Before creating any project files, confirm that
.catalystrc
and
catalyst.json
exist in the project directory. If they don't:
  1. Use MCP (
    CatalystbyZoho_List_All_Organizations
    CatalystbyZoho_List_All_Projects
    ) to get the org ID and project ID.
  2. Run:
    catalyst init --org <orgId> -p <projectId> -ni
  3. Never ask the user to run
    catalyst init
    interactively. Never create these files manually
    — they are CLI-generated and must come from the CLI.
⚠️ 预检查: 在创建任何项目文件之前,确认项目目录中存在
.catalystrc
catalyst.json
文件。如果不存在:
  1. 使用MCP(
    CatalystbyZoho_List_All_Organizations
    CatalystbyZoho_List_All_Projects
    )获取组织ID和项目ID。
  2. 运行命令:
    catalyst init --org <orgId> -p <projectId> -ni
  3. 切勿要求用户以交互方式运行
    catalyst init
    ,也切勿手动创建这些文件
    ——它们由CLI生成,必须来自CLI。

How It Works

工作流程

  1. MCP check first — Before reading any local files, look for
    CatalystbyZoho_*
    tools. If available, use MCP to get org ID, project ID, and all resource IDs instead of asking the user.
  2. New to Catalyst? — If the user is setting up Catalyst for the first time or asking "how do I start", load
    references/quick-start.md
    for the full walkthrough.
  3. Console navigation — If the user asks how to find IDs, create tables, set permissions, or configure CORS in the console, load
    references/console-ui-guide.md
    .
  4. Pre-flight — Confirm
    .catalystrc
    and
    catalyst.json
    exist. If missing, use MCP to get org/project IDs and run
    catalyst init --org <orgId> -p <projectId> -ni
    . Never use interactive
    catalyst init
    .
  5. Project structure — Load
    references/project-basics.md
    for directory layout,
    catalyst.json
    , IDs, and dev-to-prod checklist.
  6. CLI questions — Load
    references/cli.md
    for the exact command, flags, and safety rules.
  7. Answer — Provide the specific ID path or CLI command needed. Never ask the user to manually look up IDs when MCP is connected.
  1. 优先检查MCP —— 在读取任何本地文件之前,查找
    CatalystbyZoho_*
    工具。如果可用,使用MCP获取组织ID、项目ID和所有资源ID,而非询问用户。
  2. 首次接触Catalyst? —— 如果用户是首次设置Catalyst或询问“如何开始”,加载
    references/quick-start.md
    获取完整流程指南。
  3. 控制台导航 —— 如果用户询问如何查找ID、创建表格、设置权限或在控制台中配置CORS,加载
    references/console-ui-guide.md
  4. 预检查 —— 确认
    .catalystrc
    catalyst.json
    存在。如果缺失,使用MCP获取组织/项目ID并运行
    catalyst init --org <orgId> -p <projectId> -ni
    。切勿使用交互模式的
    catalyst init
  5. 项目结构 —— 加载
    references/project-basics.md
    获取目录布局、
    catalyst.json
    、ID以及开发转生产的检查清单。
  6. CLI相关问题 —— 加载
    references/cli.md
    获取确切的命令、参数和安全规则。
  7. 回答问题 —— 提供所需的具体ID路径或CLI命令。当MCP已连接时,切勿要求用户手动查找ID。

Triggers

触发场景

Use this skill for: "how do I start a Catalyst project", "what is .catalystrc", "where do I find my Table ID / ZAID / Segment ID / Project ID", "difference between Development and Production", "Catalyst project structure", "catalyst.json explained",
catalyst init
,
catalyst deploy
,
catalyst serve
,
catalyst login
, "how do I set up Catalyst with Claude", "how do I use Catalyst in Cursor", "how do I use Catalyst with GitHub Copilot", "which service should I use", "what Catalyst service for X", or any question about Catalyst IDs, environments, organizations, IDE setup, architecture decisions, or CLI subcommands.
当出现以下问题时使用本技能:“如何启动Catalyst项目”、“.catalystrc是什么”、“我在哪里找到表格ID/ZAID/分段ID/项目ID”、“开发环境与生产环境的区别”、“Catalyst项目结构”、“catalyst.json详解”、
catalyst init
catalyst deploy
catalyst serve
catalyst login
、“如何在Claude中设置Catalyst”、“如何在Cursor中使用Catalyst”、“如何在GitHub Copilot中使用Catalyst”、“我应该使用哪个服务”、“针对X场景应使用哪个Catalyst服务”,或任何关于Catalyst ID、环境、组织、IDE设置、架构决策或CLI子命令的问题。

🔌 MCP Connection Check (Do This Before Anything Else)

🔌 MCP连接检查(优先执行)

Before reading
.catalystrc
, asking the user for IDs, or doing anything project-related — check whether Zoho MCP tools are available in your tool list.
Look for tools prefixed with
CatalystbyZoho_
(e.g.,
CatalystbyZoho_List_All_Projects
,
CatalystbyZoho_List_All_Tables
).
If MCP tools ARE available:
  • Use
    CatalystbyZoho_List_All_Organizations
    to get the org ID
  • Use
    CatalystbyZoho_List_All_Projects
    to get the project ID
  • Use MCP tools to fetch table names, bucket names, ZAIDs, and all other project details directly — do NOT ask the user to copy-paste IDs from the console
If MCP tools are NOT available:
  • Prompt the user to connect Zoho MCP before proceeding
  • Guide them to: VS Code → Settings → MCP (or Claude Desktop
    claude_desktop_config.json
    ) and add the Catalyst MCP server
  • Fall back to reading
    .catalystrc
    and
    catalyst.json
    from the local project directory only as a last resort
Never ask the user to manually look up IDs from the console if MCP is connected. Every project detail — org ID, project ID, table IDs, ZAIDs, bucket names — is retrievable via MCP tools. Asking the user to hunt for IDs when MCP is available wastes time and introduces copy-paste errors.
在读取
.catalystrc
、询问用户ID或进行任何项目相关操作之前——检查工具列表中是否有Zoho MCP工具。
查找前缀为
CatalystbyZoho_
的工具(例如:
CatalystbyZoho_List_All_Projects
CatalystbyZoho_List_All_Tables
)。
如果MCP工具可用:
  • 使用
    CatalystbyZoho_List_All_Organizations
    获取组织ID
  • 使用
    CatalystbyZoho_List_All_Projects
    获取项目ID
  • 使用MCP工具直接获取表格名称、存储桶名称、ZAID和所有其他项目详情——切勿要求用户从控制台复制粘贴ID
如果MCP工具不可用:
  • 提示用户先连接Zoho MCP再继续
  • 引导他们前往:VS Code → 设置 → MCP(或Claude桌面版的
    claude_desktop_config.json
    )并添加Catalyst MCP服务器
  • 仅在万不得已时才从本地项目目录读取
    .catalystrc
    catalyst.json
    作为备选方案
当MCP已连接时,切勿要求用户从控制台手动查找ID。所有项目详情——组织ID、项目ID、表格ID、ZAID、存储桶名称——都可通过MCP工具获取。在MCP可用时让用户查找ID会浪费时间并引入复制粘贴错误。

References

参考文档

Load the relevant reference file for detailed information:
ReferenceContents
references/quick-start.md
First-time setup — install CLI,
catalyst init
, find org/project IDs, add a function, serve locally, deploy, create a Data Store table, configure CORS/Authorized Domains
references/console-ui-guide.md
Console navigation — finding Project ID/ZAID/Table ID, creating tables with typed columns, enabling App User permissions (Scopes and Permissions), Authorized Domains + CORS toggle
references/project-basics.md
Project directory structure,
catalyst.json
,
.catalystrc
,
catalyst-config.json
, environments, dev-to-prod checklist, all Catalyst IDs (Project ID, ZAID, Table ID, Segment ID, etc.)
references/cli.md
Full CLI command reference — all subcommands with flags, Slate/AppSail non-interactive setup,
catalyst serve
port behavior, deploy scoping, safety rules, resource-first development order
references/architecture.md
Service selection guide — which Catalyst service to use for which pattern, typical stack combinations, DC availability table for regionally restricted services
references/setup/claude-code.md
Installing skills and connecting Zoho MCP in Claude Code (Claude Desktop)
references/setup/cursor.md
Installing skills and connecting Zoho MCP in Cursor
references/setup/github-copilot.md
Installing skills and connecting Zoho MCP in GitHub Copilot (VS Code)
加载相关参考文件获取详细信息:
参考文档内容
references/quick-start.md
首次设置——安装CLI、
catalyst init
、查找组织/项目ID、添加函数、本地运行、部署、创建数据存储表格、配置CORS/授权域名
references/console-ui-guide.md
控制台导航——查找项目ID/ZAID/表格ID、创建带类型列的表格、启用应用用户权限(范围与权限)、授权域名+CORS开关
references/project-basics.md
项目目录结构、
catalyst.json
.catalystrc
catalyst-config.json
、环境、开发转生产检查清单、所有Catalyst ID(项目ID、ZAID、表格ID、分段ID等)
references/cli.md
完整CLI命令参考——所有带参数的子命令、Slate/AppSail非交互式设置、
catalyst serve
端口行为、部署范围、安全规则、资源优先的开发顺序
references/architecture.md
服务选择指南——针对不同模式应使用哪个Catalyst服务、典型栈组合、区域限制服务的数据中心可用性表格
references/setup/claude-code.md
在Claude Code(Claude桌面版)中安装技能并连接Zoho MCP
references/setup/cursor.md
在Cursor中安装技能并连接Zoho MCP
references/setup/github-copilot.md
在GitHub Copilot(VS Code)中安装技能并连接Zoho MCP