@devries-cameron20 / composio Mirror · read-only / commits / 483cd4a22
Fork 0

Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

Mirrored from https://github.com/Camo67/composio.git

Synced Nov 21, 06:00 UTC

docs: clarify TypeScript runtime and verified AI SDK versions (#5227)

Linear: [DEVREL-314](https://linear.app/composio/issue/DEVREL-314/supported-runtime-and-sdk-versions-not-stated) ## Problem The live GitHub getting-started guide omitted runtime prerequisites beside Installation, while the production quickstart and package engines already required Node.js >=22.22.3 and ESM imports. Gauge recommendation `cmvlk0sci02lp0iqv6b4w4hw2` remains OPEN: run `cmvfzamhp00ag01nufbw9risx`, seq 34, recovered from scaffolding Node >=20 only after reading installed package metadata. Its web inventory confirms it fetched `https://github.com/composiohq/composio/blob/next/ts/docs/getting-started.md`. Run `cmvhl1p70002901j6uo81lfb4`, seq 7, asked the developer to verify AI SDK 7 adapter compatibility without fetching any owned content; that is uncertainty, not proof of incompatibility. The supplied PR identifier search found no covering PR, and the omission is present at origin/next `e8782784b9af1cdc46895554235b6cf51398e04c`. **Root cause.** ComposioHQ/composio owns the handwritten guide and package README sources. Runtime constraints were declared in package manifests and the current web quickstart but omitted from these installation entry points. Published artifact inspection confirmed that @composio/core@0.28.0 ships README.md and src/composio.ts, whereas @composio/openai-agents@0.11.2 ships README.md and dist/index.{mjs,d.mts}, not src/index.ts. The inspected README examples already use ESM imports; they lacked the prerequisite explanation before installation. PRDE-1387's Done state was not used as release evidence: npm independently supplied @composio/vercel@0.13.0 with peer ai ^6.0.0 || ^7.0.0, and an isolated consumer established the exact checked combination. ## Change Committed as `c4841b313` on the requested branch. Added Node.js 22.22.3+, ESM-only imports, and package.json type: module guidance immediately before installation in the GitHub guide and the core, OpenAI Agents, and Vercel package READMEs. The guide and core/OpenAI Agents READMEs link to the verified current SDK quickstart. Added a separate Verified SDK versions paragraph to the Vercel README naming published @composio/core@0.28.0, @composio/vercel@0.13.0, and ai@7.0.162, the checked Node/TypeScript versions, and the explicit limit that typechecking and ESM loading do not prove live model/tool execution. Preserved legacy guide examples and distributed declaration examples; changed no SDK implementation, engine constraint, peer range, generator, or release automation. No changeset is needed for this documentation-only change. ## Verification exercised - Fetched the live GitHub getting-started guide and production quickstart Markdown: the guide omitted prerequisites; the quickstart stated Node.js 22.22.3+ and ESM-only imports. The canonical quickstart URL resolved through its Markdown alternate. - Read Gauge CLI instructions/help, the current recommendation, both cited run insights, trace windows, the full relevant compatibility caveat, and source/prior-replay web inventories using read-only hosted commands. The compatibility source fetched no pages; prior replay cmvueqmo200r801gay1yn9q9w also fetched no pages, so no previous changed-section exposure or correction effect is established. - npm view and published npm tarball inspection confirmed @composio/core@0.28.0 and @composio/openai-agents@0.11.2 require Node >=22.22.3, use ESM exports, and expose the inspected README/declaration/source paths; @composio/vercel@0.13.0 declares ai ^6.0.0 || ^7.0.0. - An isolated npm consumer installed exact @composio/core@0.28.0, @composio/openai-agents@0.11.2, @openai/agents@0.20.0, @composio/vercel@0.13.0, and ai@7.0.162. TypeScript 6.0.2 compiled strict NodeNext consumer code with skipLibCheck, checking real session.tools() types passed to AI SDK generateText/streamText and OpenAI Agents Agent/run; exit 0 on Node v24.22.1. - Loaded that compiled consumer with Node ESM imports successfully; credentialed functions were not called. npm ls confirmed the exact dependency versions and deduplicated adapter peers. - npm pack --ignore-scripts on the three local package sources included each changed package/README.md; opened each tarball README and observed the new installation guidance and Vercel version paragraph. This was a README inclusion check, not a built-runtime package validation. - A temporary Marked 17.0.1 GFM/Bun HTTP harness served all four complete changed documents as HTML and raw Markdown. Both variants returned HTTP 200 with correct content types; raw bytes matched source and rendered Node/ESM/import/require/type:module guidance preceded installation commands. The first throwaway harness assertion incorrectly expected literal quotes in HTML; inspecting renderer output established &quot; escaping, and the corrected exact escaped-HTML assertion passed all four documents. - Portable Bun Markdown rendering check passed for all four changed files; package README Prettier 3.9.10 check passed for all three READMEs. - Reviewed the complete four-file diff against issue scope: only 14 documentation lines added; legacy examples, package constraints, and release automation unchanged. Commit succeeded and final git status showed a clean worktree. Temporary consumer, renderer, dependencies, and tarballs were removed; the local server was stopped. Rerun by the Agent Experience Factory on the pushed commit before opening this PR: - `NODE_OPTIONS=--max-old-space-size=4096 bunx prettier@3.9.10 --check ts/packages/core/README.md ts/packages/providers/openai-agents/README.md ts/packages/providers/vercel/README.md` in `.` — exit 0 - `NODE_OPTIONS=--max-old-space-size=4096 bun -e 'for (const path of Bun.argv.slice(1)) { const md = await Bun.file(path).text(); const html = Bun.markdown.html(md); const start = html.indexOf("Installation</h2>"); const install = html.slice(start, html.indexOf("<pre", start)); if (start < 0 || !install.includes("Node.js 22.22.3 or newer") || !install.includes("ESM-only") || !install.includes("require()") || !md.includes("https://docs.composio.dev/docs/quickstart") && !path.includes("/vercel/")) throw new Error(path); console.log(path + ": rendered prerequisites precede installation"); }' ts/docs/getting-started.md ts/packages/core/README.md ts/packages/providers/openai-agents/README.md ts/packages/providers/vercel/README.md` in `.` — exit 0 ## Remaining validation - Publication pending: merge the guide into next to expose its changed Installation section at the cited GitHub URL; publish the core, OpenAI Agents, and Vercel package README changes through existing release automation to expose them in installed node_modules/@composio/<package>/README.md. Nothing was pushed, released, or deployed. - Post-publication Gauge validation pending for recommendation cmvlk0sci02lp0iqv6b4w4hw2 with unchanged criteria and the cited source sessions. Verify actual exposure to the guide's Node/ESM paragraphs or installed README installation/version paragraphs, then establish original-finding removal and no material new findings. No Gauge run, evaluation, optimization, or paid action was started; no passing Gauge outcome or causal credit is claimed. - No credentialed Composio session creation, model request, connected-account action, or live tool execution was performed. The isolated typecheck and ESM import smoke are not live-action evidence, and they do not prove every AI SDK 7 release compatible. - The minimum Node requirement is verified against authoritative source and published manifests; runtime smoke used Node 24.22.1, not Node 22.22.3. - HTML smoke used local Markdown renderers, not GitHub's production UI or a visual browser. No full monorepo build/test suite was run for this documentation-only change; local npm packs were not release builds. Published runtime artifacts were exercised separately in the isolated consumer. Not merged or deployed. A matched Gauge retest can only run after deployment. <sub>Opened by the Agent Experience Factory to improve agent preference across docs and landing pages (queue `2026-11-04-next`).</sub>

Brendan O'Leary committed Nov 9, 2026 at 02:40 UTC 483cd4a22e794039aef4c7ff39def075b77bdf39
4 files changed +14
ts/docs/getting-started.md
+4
@@ -4,6 +4,10 @@ This guide will help you get started with the Composio SDK. You'll learn how to
4
5 ## Installation
6
7 +The TypeScript SDK requires **Node.js 22.22.3 or newer** and is **ESM-only**. Use `import` syntax rather than CommonJS `require()`, and set `"type": "module"` in your project's `package.json`.
8 +
9 +For the current session-based examples and framework setup, see the [SDK quickstart](https://docs.composio.dev/docs/quickstart).
10 +
11 Install the Composio SDK using npm, yarn, or pnpm:
12
13 ```bash
ts/packages/core/README.md
+2
@@ -6,6 +6,8 @@ Full documentation lives at [docs.composio.dev](https://docs.composio.dev). This
6
7 ## Installation
8
9 +You need **Node.js 22.22.3 or newer**. The SDK is **ESM-only**: use `import` rather than CommonJS `require()`, and set `"type": "module"` in your project's `package.json`. See the [SDK quickstart](https://docs.composio.dev/docs/quickstart) for framework setup.
10 +
11 ```bash
12 npm install @composio/core
13 ```
ts/packages/providers/openai-agents/README.md
+2
@@ -4,6 +4,8 @@ Composio provider for the [OpenAI Agents SDK](https://openai.github.io/openai-ag
4
5 ## Installation
6
7 +You need **Node.js 22.22.3 or newer**. The SDK is **ESM-only**: use `import` rather than CommonJS `require()`, and set `"type": "module"` in your project's `package.json`. See the [SDK quickstart](https://docs.composio.dev/docs/quickstart) for framework setup.
8 +
9 ```bash
10 npm install @composio/core @composio/openai-agents @openai/agents
11 ```
ts/packages/providers/vercel/README.md
+6
@@ -4,6 +4,8 @@ Composio provider for the [Vercel AI SDK](https://sdk.vercel.ai) (`ai`). It conv
4
5 ## Installation
6
7 +You need **Node.js 22.22.3 or newer**. The SDK is **ESM-only**: use `import` rather than CommonJS `require()`, and set `"type": "module"` in your project's `package.json`.
8 +
9 ```bash
10 npm install @composio/core @composio/vercel ai @ai-sdk/anthropic
11 ```
@@ -15,6 +17,10 @@ Set two environment variables:
17 - `COMPOSIO_API_KEY` from the [Composio dashboard](https://dashboard.composio.dev/settings)
18 - `ANTHROPIC_API_KEY` from [Anthropic](https://console.anthropic.com/settings/keys) (or the key for your chosen model provider)
19
20 +### Verified SDK versions
21 +
22 +The published packages `@composio/core@0.28.0`, `@composio/vercel@0.13.0`, and `ai@7.0.162` pass a consumer typecheck on Node.js 24.22.1 with TypeScript 6.0.2. The check passes session tools to both `generateText` and `streamText` and loads the compiled ESM imports. This verifies the TypeScript integration, not live model or tool execution.
23 +
24 ## Quickstart
25
26 Create a session for your user, pass its tools to the AI SDK, and cap the run with `stopWhen`: