Files
simstudioai--sim/.claude/rules/sim-integrations.md
T
wehub-resource-sync d25d482dc2
CI / Migrate DB (push) Blocked by required conditions
CI / Migrate Dev DB (push) Waiting to run
CI / Build Dev ECR (./docker/db.Dockerfile, ECR_MIGRATIONS) (push) Blocked by required conditions
CI / Create GHCR Manifests (ghcr.io/simstudioai/realtime) (push) Blocked by required conditions
CI / Build Dev ECR (./docker/pii.Dockerfile, ECR_PII) (push) Blocked by required conditions
CI / Build Dev ECR (./docker/realtime.Dockerfile, ECR_REALTIME) (push) Blocked by required conditions
CI / Deploy Trigger.dev (Dev) (push) Blocked by required conditions
CI / Build AMD64 (./docker/app.Dockerfile, ECR_APP, ghcr.io/simstudioai/simstudio) (push) Blocked by required conditions
CI / Build ARM64 (GHCR Only) (./docker/db.Dockerfile, ghcr.io/simstudioai/migrations) (push) Blocked by required conditions
CI / Build ARM64 (GHCR Only) (./docker/pii.Dockerfile, ghcr.io/simstudioai/pii) (push) Blocked by required conditions
CI / Build ARM64 (GHCR Only) (./docker/realtime.Dockerfile, ghcr.io/simstudioai/realtime) (push) Blocked by required conditions
CI / Create GHCR Manifests (ghcr.io/simstudioai/migrations) (push) Blocked by required conditions
CI / Create GHCR Manifests (ghcr.io/simstudioai/pii) (push) Blocked by required conditions
CI / Create GHCR Manifests (ghcr.io/simstudioai/simstudio) (push) Blocked by required conditions
CI / Check Docs Changes (push) Waiting to run
CI / Process Docs (push) Blocked by required conditions
CI / Create GitHub Release (push) Blocked by required conditions
Publish CLI Package / publish-npm (push) Waiting to run
Publish Python SDK / publish-pypi (push) Waiting to run
Publish TypeScript SDK / publish-npm (push) Waiting to run
CI / Test and Build (push) Waiting to run
CI / Build Dev ECR (./docker/app.Dockerfile, ECR_APP) (push) Blocked by required conditions
CI / Build AMD64 (./docker/db.Dockerfile, ECR_MIGRATIONS, ghcr.io/simstudioai/migrations) (push) Blocked by required conditions
CI / Build AMD64 (./docker/pii.Dockerfile, ECR_PII, ghcr.io/simstudioai/pii) (push) Blocked by required conditions
CI / Build AMD64 (./docker/realtime.Dockerfile, ECR_REALTIME, ghcr.io/simstudioai/realtime) (push) Blocked by required conditions
CI / Build ARM64 (GHCR Only) (./docker/app.Dockerfile, ghcr.io/simstudioai/simstudio) (push) Blocked by required conditions
CI / Detect Version (push) Waiting to run
chore: import upstream snapshot with attribution
2026-07-13 13:20:55 +08:00

1.7 KiB

paths
paths
apps/sim/tools/**
apps/sim/blocks/**
apps/sim/triggers/**

Adding Integrations

Build order: Tools (tools/{service}/) → Block (blocks/blocks/{service}.ts) → Icon (components/icons.tsx) → optional Trigger (triggers/{service}/). Always look up the service's API docs first.

The full authoring instructions — tool/block/icon/trigger scaffolding, SubBlock property tables, condition/required/dependsOn/mode/canonicalParamId syntax, the normalizeFileInput/file-handling helper table, and checklists — live in the skills: /add-integration (end-to-end), /add-tools, /add-block, /add-trigger.

Hard rules (don't get these wrong)

  • Tool IDs are snake_case (service_action). Register tools in tools/registry.ts, blocks in blocks/registry-maps.ts (the BLOCK_REGISTRY config map + BLOCK_META_REGISTRY catalog-meta map, alphabetically — blocks/registry.ts holds only the accessor functions), triggers in triggers/registry.ts.
  • Type coercions (Number(), etc.) belong in tools.config.params (runs at execution, after variable resolution) — never in tools.config.tool (runs at serialization; coercing there destroys dynamic <Block.output> references).
  • canonicalParamId must NOT match any subblock's id, must be unique per operation/condition context, and all subblocks in a canonical group must share the same required status. The inputs section and the params function reference canonical IDs, not raw subblock IDs.
  • Blocks must also set the catalog/UI metadata fields integrationType, tags, authMode, docsLink, and export a {Service}BlockMeta — see the /add-block skill's BlockMeta section for details.