Skip to content

Add shell-discovery guidance and example skeletons to the zapier-sdk skill - #13

Merged
BenMcGit merged 1 commit into
mainfrom
chore/skill-shell-discovery-and-examples
Jul 9, 2026
Merged

Add shell-discovery guidance and example skeletons to the zapier-sdk skill#13
BenMcGit merged 1 commit into
mainfrom
chore/skill-shell-discovery-and-examples

Conversation

@BenMcGit

@BenMcGit BenMcGit commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

Summary

  • New "Shell discovery" section in SKILL.md. Agents doing discovery from a shell were reinventing basic flows because the skill front-loaded the SDK library and pushed CLI content into references/cli.md. zapier-sdk --help doesn't advertise --json (it's a per-command flag), so agents kept parsing the default table output. The new section shows the four essential commands and the canonical find-first-connection --json | jq -r '.data.id' -> run-action chain, and clarifies that default output is best for reading; --json is for piping.
  • Rewrote the app-key gotcha. The old wording implied the CLIAPI-suffixed form (NotionCLIAPI) was universal. In practice, only the SDK library's sdk.runAction({ appKey }) requires it; the CLI's run-action, findFirstConnection, listActions, and so on all accept the short slug too.
  • New multi-connection gotcha. Users often have several connections per app (personal + work Gmail, multiple Slack workspaces). Default to findFirstConnection and take the first result rather than stopping to disambiguate.
  • New references/examples.md. Fill-in-the-blank skeletons for a plain single-action script, a Zapier Tables script, and a durable notify-on-event workflow. Every placeholder is called out (<app-slug>, <AppCLIAPI>, <action-key>, ...). Opens and closes with pointers back to the verified corpus at examples/ and https://github.com/zapier/sdk/tree/main/examples so agents don't ship the unverified skeletons themselves.

Test plan

  • Skim the new Shell discovery section and confirm the CONN=$(...) -> run-action snippet works against a fresh login.
  • Confirm the rewritten app-key gotcha reads unambiguously as SDK-library-only.
  • Skim references/examples.md: every placeholder is obviously a placeholder, and the "real corpus lives here" pointers land at the start and end of the file.
  • Existing CI (validate.yml) still green (no changes to gated paths).

…skill

Agents doing SDK discovery from a shell were reinventing basic flows because
the skill front-loaded the SDK library and pushed CLI content into
`references/cli.md`. `zapier-sdk --help` doesn't advertise `--json` (it's a
per-command flag), so agents kept parsing the default table output. The
"App keys have a canonical form" gotcha implied the CLIAPI suffix was
universal, but the CLI's `run-action` accepts the short slug too, and only
the SDK library's `sdk.runAction({ appKey })` requires the suffixed form.

Changes to `SKILL.md`:
- New "Shell discovery" section with the four essential commands and a
  canonical `find-first-connection --json | jq -r '.data.id'` -> `run-action`
  chain. Recommends the default output for reading and reserves `--json` for
  piping.
- Rewrites the app-key gotcha to make clear it applies to `sdk.runAction`
  only; the CLI, `findFirstConnection`, `listActions`, and so on all accept
  either form.
- New gotcha: multiple connections per app is normal (personal + work Gmail,
  multiple Slack workspaces). Default to `findFirstConnection` and take the
  first result rather than stopping to disambiguate.
- New "Examples" pointer to the skeletons file.

New `references/examples.md`:
- Fill-in-the-blank skeletons for a plain single-action script, a Zapier
  Tables script, and a durable notify-on-event workflow. Every placeholder
  is called out (`<app-slug>`, `<AppCLIAPI>`, `<action-key>`, ...).
- Opens and closes with pointers back to the verified corpus at
  https://github.com/zapier/sdk/tree/main/examples so agents don't ship the
  unverified skeletons themselves.
@BenMcGit
BenMcGit force-pushed the chore/skill-shell-discovery-and-examples branch from 6d81493 to 16f37da Compare July 9, 2026 16:03
@BenMcGit
BenMcGit merged commit 65fc647 into main Jul 9, 2026
2 checks passed
@BenMcGit
BenMcGit deleted the chore/skill-shell-discovery-and-examples branch July 9, 2026 19:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant