Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
65 changes: 64 additions & 1 deletion .agents/skills/add-integration/SKILL.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: add-integration
description: Add a complete Sim integration from API docs, covering tools, block, icon, optional triggers, registrations, and integration conventions. Use when introducing a new service under `apps/sim/tools`, `apps/sim/blocks`, and `apps/sim/triggers`.
description: Add a complete Sim integration from API docs, covering tools, block, icon, optional triggers, registrations, resolved-secret/model-input safety, and integration conventions. Use when introducing a new service under `apps/sim/tools`, `apps/sim/blocks`, and `apps/sim/triggers`.
argument-hint: <service-name> [api-docs-url]
---

Expand Down Expand Up @@ -122,6 +122,64 @@ export const {service}{Action}Tool: ToolConfig<Params, Response> = {
- When using `type: 'json'` and you know the object shape, define `properties` with the inner fields so downstream consumers know the structure. Only use bare `type: 'json'` when the shape is truly dynamic
- If you do not know the response JSON shape from docs or verified examples, you MUST tell the user and stop. Never guess outputs or response mappings.

### Resolved Secrets at Model and Persistence Boundaries

Classify every request field before implementing the tool:

This is opt-in, not a blanket integration migration. Add a model-input declaration only when the
service's official documentation or an unambiguous local execution path proves that the exact
field is consumed by an AI model. If that cannot be established, preserve existing tool behavior
and leave the field unannotated.

- **Ordinary provider/API input:** leave it unchanged. Do not add blanket result sanitization.
- **Text or structured content consumed by an AI model:** declare `request.modelInput` with
`mode: 'project'` and select only the exact model-visible fields. The shared executor replaces
activated Sim secrets with canonical `{{NAME}}` labels before request formatting. For nested or
JSON-string fields, use a small shared selector plus `applyProjected`; verify that selecting the
rebuilt params reproduces the projected selection.
- **Opaque model input sent directly to an external provider** such as a model-read URL or image
payload: declare `request.opaqueModelInput` with `mode: 'reject-resolved-secrets'` and select only
the exact effective value. The shared `executeTool` preflight rejects incomplete or secret-bearing
committed provenance before URL/body formatting or network I/O, preserves safe request bytes,
and sends no provenance metadata to the provider.
- **Opaque model input owned by an authenticated internal route** such as uploaded audio, image,
video, file bytes, or signed URLs: add `privateProvenance` to a projected request, or use
`mode: 'private-provenance'` when there is no textual projection. The route must call
`validateOpaqueModelInputProvenance` before downloading or sending content to the model and must
apply the workspace-file provenance guard before reading a persisted workspace file.
- **Sim-owned durable storage or internal execution handoff** that can later enter a workflow/model
(table cells, Agent memory, knowledge documents/chunks, workspace-file contents, or child-workflow
input): transport encrypted field-scoped provenance with `request.secretProvenance`. The
authenticated receiver validates the exact selection and scope, strips the private envelope, and
persists, imports, or propagates it at the owning boundary. Preserve shared legacy behavior for
headerless internal calls and rows/files whose provenance marker is `NULL`; never invent a
tool-local migration rule.

Hard rules:

- Never substitute secret plaintext into source or serialize plaintext provenance.
- Never hand-roll private provenance headers/envelopes; the shared `executeTool` boundary owns
transport and strips private metadata from functional results.
- Never attach private provenance to an external URL or to `directExecution`. Use the centralized
`opaqueModelInput` rejection mode for external/direct opaque model inputs, or an authenticated
internal route when encrypted provenance must cross the boundary.
- Never sanitize arbitrary third-party tool results. Projection applies only to secrets activated
by Sim's resolved-secret provenance for that execution/tool call.
- Do not add provenance merely because a value is persisted, returned by a tool, or appears in a
filename. Require a concrete Sim `{{...}}` resolution path and a later model/log boundary. If an
unsupported field can resolve a secret but does not justify durable tracking (for example a
`file_write` path), reject it at that exact ingress.
- At diagnostic boundaries, project only values carrying execution-scoped provenance. Ordinary
provider responses, filenames, URLs, and errors remain unchanged when Sim did not resolve a
secret into them.

Add focused tests covering named projection, ordinary identical text without provenance, nested
shape preservation, malformed/incomplete private metadata failing closed, centralized external
opaque rejection before formatting/I/O without byte changes or metadata transport, headerless
legacy requests, and absence of private metadata in the public tool result. For durable sinks, also
cover legacy `NULL` markers, exact-empty new writes, tracked secret writes, stale/missing sidecars,
and scope isolation.

## Step 3: Create Block

### File Location
Expand Down Expand Up @@ -535,6 +593,11 @@ If creating V2 versions (API-aligned outputs):
- [ ] Created `index.ts` barrel export
- [ ] Registered all tools in `tools/registry.ts`
- [ ] Ran `bun run tool-metadata:generate` and committed the regenerated artifacts
- [ ] Classified every model-visible, opaque, Sim-durable, and internal-execution request field
- [ ] Added shared model-input projection, centralized opaque rejection, or private provenance only
where required
- [ ] Confirmed ordinary third-party tool results are not generically sanitized
- [ ] Added provenance compatibility and fail-closed boundary tests where applicable

### Block
- [ ] Created `blocks/blocks/{service}.ts`
Expand Down
149 changes: 149 additions & 0 deletions .agents/skills/add-managed-cli/SKILL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,149 @@
---
name: add-managed-cli
description: Add or upgrade a curated, immutable managed CLI for Sim Function sandboxes, including client-safe catalog metadata, a pinned server-only installation recipe, checksum and executable verification, provider compatibility, PATH propagation, content-addressed image identity, and tests. Use when adding a CLI to the Sandbox managed-CLI selector or changing an existing managed CLI version or recipe.
---

# Add a Managed CLI

Add CLIs through the curated registry. Never turn this surface into arbitrary commands or package names: system packages already cover validated Debian/APT coordinates, while managed CLIs require immutable artifacts and reproducible recipes.

## Read First

Read these live sources before editing; do not copy their current entries into this skill:

1. `apps/sim/lib/execution/remote-sandbox/cli-tools.ts` — persisted IDs and client-safe metadata.
2. `apps/sim/lib/execution/remote-sandbox/cli-tools.server.ts` — server-only recipes and recipe helpers.
3. `apps/sim/lib/execution/remote-sandbox/cli-tools.test.ts` — catalog and supply-chain invariants.
4. `apps/sim/lib/execution/remote-sandbox/cli-tools-boundary.test.ts` — client/server import boundary.
5. `apps/sim/lib/execution/remote-sandbox/sandbox-spec.ts` — content-addressed hash inputs.

Read `resolve.ts` and `e2b.ts` only when changing provisioning mechanics. A normal catalog addition should not require UI, API, database, resolver, or provider edits; those paths derive from the registries.

Do not modify the dedicated Function base image or the separate Mothership Shell template for a normal managed CLI addition. Managed recipes layer on the Function base image. Do not change `MAX_SANDBOX_CLI_TOOLS` from ten unless the user separately requests a product-limit change.

## 1. Verify the Upstream Release

Use primary upstream release documentation and official artifacts. Establish all of the following before writing code:

- Exact version and stable Linux x86-64 artifact URL. Never use `latest`, mutable redirects, or an unversioned installer.
- SHA-256 for the exact artifact. Prefer a publisher-signed checksum; otherwise download the official artifact and compute it independently.
- Archive layout and the exact executable paths to install.
- Noninteractive, credential-free verification commands for every advertised executable, normally version commands.
- Required PATH entries under `/opt/sim-cli`.
- E2B and Daytona compatibility. Default to both only when the same Linux recipe works on both.

When the user does not name a version, select the current stable upstream release from primary sources and state the exact version chosen. Do not silently choose a prerelease or infer a version from an unverified secondary source.

Reject curl-to-shell installers, `npm install`, `pip install`, distro package repositories, arbitrary user commands, and artifacts from unofficial mirrors. Never place credentials, tokens, login commands, or account configuration in an image recipe or build log; authentication is runtime-only.

## 2. Choose an Immutable ID

Use `<tool>@<upstream-version>-r<recipe-revision>`.

- New upstream version: append a new ID ending in `-r1`.
- Recipe-only change for the same upstream version: append `-r2`, `-r3`, and so on.
- Never mutate or delete an existing ID or recipe. Persisted sandboxes must continue resolving to the bytes and behavior they selected.
- On upgrade, retain the old ID and recipe and set its metadata to `selectable: false`. Only the newest version keeps the public label selectable.

Before shipping the first upgrade for a tool family, verify that editing a sandbox cannot leave both the retired and replacement IDs selected. If the generic selector and API validation do not already replace or reject colliding versions, address that once at the generic registry boundary with focused UI and contract tests; never special-case the individual CLI or silently install two versions that expose the same executable.

Recipe identity includes the ID, revision, and SHA-256 in the sandbox image hash. Keeping old entries is what makes that identity reproducible rather than merely cache-busting.

## 3. Add Client-Safe Metadata

In `cli-tools.ts`:

1. Append the ID to `SANDBOX_CLI_TOOL_IDS` in the same order used by the metadata and recipe registries.
2. Add a `SANDBOX_CLI_TOOLS` entry whose key and `id` exactly match.
3. Provide a unique selectable `label`, concise `description`, existing `category`, and useful executable/vendor aliases in `searchTerms`.
4. Add a category only when no existing category is accurate, then ensure it has at least one selectable entry.

Keep this file safe for client bundles. It must not contain artifact URLs, checksums, install commands, verification commands, PATH recipes, provider SDKs, or imports from `cli-tools.server.ts`.

The API enum and searchable grouped selector derive from this registry. Do not add parallel option arrays or route-local wire types.

## 4. Add the Server-Only Recipe

In `cli-tools.server.ts`, use the narrowest existing helper:

- `defineBinaryRecipe` for one downloaded binary.
- `defineTarGzipRecipe` or `defineZipRecipe` for archives containing binaries.
- `defineVerifiedRecipe` for a vendor archive or installer layout that needs explicit commands.
- A direct typed entry only when the helpers cannot faithfully model the release.

Provide every field the recipe contract requires:

- Exact `version`, `artifactUrl`, `artifactName`, and lowercase 64-character `sha256`.
- Every installed `executable` and a corresponding `verificationCommands` entry.
- Deterministic extraction/install commands into `/opt/sim-cli`; quote fixed paths and clean temporary artifacts.
- `pathEntries` when the executable is not installed into the helper's default `bin` directory.
- `supportedProviders` only when it differs from the E2B-and-Daytona default.
- `revision` when it differs from `1`; it must agree with the ID suffix.

Verification must prove the command is discoverable through `sandboxCliEnvironment`, not authenticate or contact a user account. Recipe commands run as root during both prebuilt image creation and runtime provisioning.

If the artifact host is new, add only the exact official hostname to the `officialHosts` allowlist in `cli-tools.test.ts`. Treat that as a supply-chain review, not a way to silence the test.

## 5. Preserve Generic Behavior

Confirm the existing generic paths remain sufficient:

- `sandboxCliToolRecipes` canonicalizes and resolves the recipe.
- `sandboxCliEnvironment` propagates PATH to Python subprocesses, JavaScript subprocesses, and Shell.
- E2B bakes the recipe into the custom image; runtime-strategy providers install it within the Function timeout.
- CLI-only sandboxes remain buildable even with no language packages.
- `hashSandboxSpec` includes recipe ID, revision, and checksum while preserving the legacy hash for an empty CLI list.
- The settings selector derives groups and search aliases from client-safe metadata.

Do not special-case a CLI in those layers unless the registry contract cannot express a genuine provider requirement. Extend the registry contract generically when multiple CLIs need the same new behavior.

## 6. Test the Addition

Extend tests when the new entry introduces behavior not already covered:

- For every upgrade, add a regression proving the old ID and recipe remain resolvable but non-selectable, while the replacement ID is selectable.
- Add important executable aliases to the table-driven search assertion.
- Add a focused assertion for a multi-executable recipe, custom PATH, or restricted provider.
- Add an opt-in credentialed smoke test only when installation plus a real minimal command cannot be validated without authentication. Read credentials from test-only environment variables, skip by default, create them only at runtime, and always tear down the sandbox.

Never commit downloaded artifacts or credentials.

## Required Validation

From `apps/sim`:

```bash
bunx vitest run \
lib/execution/remote-sandbox/cli-tools.test.ts \
lib/execution/remote-sandbox/cli-tools-boundary.test.ts \
lib/execution/remote-sandbox/sandbox-spec.test.ts \
lib/execution/remote-sandbox/resolve.test.ts \
lib/api/contracts/sandboxes.test.ts \
'app/workspace/[workspaceId]/settings/components/sandboxes/utils.test.ts' \
'app/workspace/[workspaceId]/settings/components/sandboxes/components/sandbox-editor.test.tsx'
```

From the repository root:

```bash
bun run type-check
bun run check:api-validation
bunx biome check \
apps/sim/lib/execution/remote-sandbox/cli-tools.ts \
apps/sim/lib/execution/remote-sandbox/cli-tools.server.ts \
apps/sim/lib/execution/remote-sandbox/cli-tools.test.ts
git diff --check
```

For a new recipe, also exercise its install and every verification command in an actual E2B or Daytona sandbox when credentials and network access are available. Report clearly when only registry/unit validation ran.

## Completion Checklist

- [ ] Official immutable Linux x86-64 artifact and SHA-256 verified.
- [ ] Versioned ID appended; old IDs and recipes retained.
- [ ] Client metadata is searchable, categorized, unique, and recipe-free.
- [ ] Server recipe is pinned, integrity-checked, noninteractive, and credential-free.
- [ ] Every advertised executable has an offline verification command and PATH entry.
- [ ] Provider compatibility is explicit and accurate.
- [ ] Catalog, boundary, hash, resolver, type, API-validation, format, and diff checks pass.
- [ ] Real provider installation was tested, or the missing live verification is disclosed.
4 changes: 4 additions & 0 deletions .agents/skills/add-managed-cli/agents/openai.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
interface:
display_name: "Add Managed CLI"
short_description: "Add a verified CLI to sandbox images"
default_prompt: "Use $add-managed-cli to add a pinned, verified CLI to Sim sandbox images."
19 changes: 19 additions & 0 deletions .agents/skills/add-tools/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,22 @@ export const {serviceName}{Action}Tool: ToolConfig<
- Always explicitly set `required: true` or `required: false`
- Optional params should have `required: false`

## Resolved Secrets and Provenance Boundaries

- Leave ordinary external API inputs and third-party results unchanged. Add provenance handling only
when an exact field is proven to cross a Sim model, durable-storage, or internal-execution boundary.
- Project AI-consumed text/structured fields with the smallest exact `request.modelInput` selector.
- Reject resolved secrets in opaque model input sent directly to an external provider with
`request.opaqueModelInput`; never attach private metadata to an external URL or `directExecution`.
- For authenticated internal routes, use `privateProvenance` for opaque model input or
`request.secretProvenance` for durable writes and execution handoffs. Authenticate first, validate
the exact selection and scope, strip the private envelope, then import or propagate provenance at
the receiving boundary. Preserve documented headerless legacy behavior.
- Never substitute secret plaintext into source, serialize plaintext provenance, hand-roll private
headers, or blanket-sanitize tool results.
- Add focused tests for named projection, identical unproven public text, malformed/incomplete
metadata, metadata stripping, scope isolation, and legacy compatibility where applicable.

## Critical Rules for Outputs

### Output Types
Expand Down Expand Up @@ -456,6 +472,9 @@ All tool IDs MUST use `snake_case`: `{service}_{action}` (e.g., `x_create_tweet`
- [ ] Tools registered in `tools/registry.ts`
- [ ] `bun run tool-metadata:generate` run and the regenerated artifacts committed
- [ ] Block wired: `tools.access`, dropdown options, subBlocks, `tools.config`, outputs, inputs
- [ ] Model, durable-storage, and internal-execution boundaries use the shared provenance mechanisms
only where a concrete Sim `{{...}}` resolution path requires them
- [ ] Ordinary third-party inputs/results remain unchanged and private metadata never leaves Sim

## Final Validation (Required)

Expand Down
3 changes: 2 additions & 1 deletion .agents/skills/ship/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,8 @@ When the user runs `/ship`:
for s in check:boundaries check:api-validation:strict check:desktop-bridge check:desktop-ipc \
check:utils check:zustand-v5 \
check:react-query check:client-boundary check:bare-icons check:icon-paths \
check:realtime-prune check:tool-registry-boundary tool-metadata:check \
check:realtime-prune check:tool-registry-boundary check:tool-request-boundary \
tool-metadata:check \
integration-catalog:check skills:check agent-stream-docs:check; do
( bun run "$s" >"/tmp/ship-audit-${s//:/-}.log" 2>&1; echo "$? $s" >>/tmp/ship-audit-results ) &
done
Expand Down
Loading
Loading