docs(decisions): add SDK v1.0 stability, parity, and migration ADRs#3670
docs(decisions): add SDK v1.0 stability, parity, and migration ADRs#3670Alberto Schiabel (jkomyno) wants to merge 23 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit d3eaccb. Configure here.
25affad to
cb04a69
Compare
Record the decisions settled for a coordinated Composio SDK 1.0: - sdk-1.0-stability-contract: scope (core + providers in; CLI and utility packages out), stable vs experimental tiers (Tool Router stabilized to stable, MCP stays experimental), coordinated milestone with independent version numbers, generated-client graduation, and the deprecation/rename-alias policy. - cross-sdk-parity-policy: TypeScript as reference implementation, the 1:1 naming rule and the @composio/google -> @composio/gemini rename, declared (n/a-by-design) provider divergence, Python sync + async, the shared COMPOSIO:: error-code catalog, the validate:sdk-parity check, and the living parity matrix. - sdk-v0-to-v1-migration: final 0.x deprecation release, alias bridges through 1.x removed at 2.0, server-driven retirement of initiate(), plus codemod + v1-migration skill + migration doc page + docs version selector. Indexed in docs/decisions/README.md.
Companion to the v1.0 ADRs: the side-by-side SDK comparison and the engineering backlog (blockers B1-B9, should-settle items, sequencing) that the decision records reference but do not track. The decisions themselves live in docs/decisions/.
Relocate the parity-and-readiness analysis from the repo root to docs/decisions/sdk-v1-readiness.md so it sits beside the ADRs it supports, and index it in the README.
d3eaccb to
02c4ba1
Compare
Record the decision to replace Stainless with a self-hosted Hey API codegen pipeline for composio-base-ts (@composio/client) and composio-base-py (composio-client), keeping the deterministic schema-committed PR flow. Wire it into the decisions index and cross-reference it from the 1.0 stability contract's generated-client section. Also fold in the parity-policy and readiness refinements that mark validate:sdk-parity as planned (B9).
Fold the experimental (ctx, next) session-hooks proposal for session.tools(...) into the SDK decision-record set, modeled on the Pi provider's existing hooks. Index it in the decisions README.
|
Claude finished Alberto Schiabel (@jkomyno)'s task in 1m 51s —— View job Docs review — SDK v1.0 decision records
Reviewed against 1. Confirmed — MCP tier is ambiguous (agrees with Cursor Bugbot) ·
|
|
The Please review and fix the vulnerabilities. You can try running: pnpm audit --fix --prodAudit output |
One plan per road-to-v1.md phase (Steps 1-6, three parallel lanes) plus a client-passthrough plan exposing granular Tool Router session flags (search.enable, execute.enable_multi_execute) that today are only reachable through SESSION_PRESET_DIRECT_TOOLS or the raw client. Each plan carries requirements, key decisions, unit breakdown, and verification gates; all ten were adversarially reviewed with codex.
|
Claude finished Alberto Schiabel (@jkomyno)'s task in 1m 37s —— View job Docs review — SDK v1.0 decision records
Reviewed against 1. Still open — Experimental tier definition excludes top-level
|
|
Claude finished Alberto Schiabel (@jkomyno)'s task in 1m 14s —— View job Docs review — SDK v1.0 decision records
Reviewed against 1. Still open — Experimental tier definition excludes top-level
|
|
Claude finished Alberto Schiabel (@jkomyno)'s task in 1m 7s —— View job Docs review — SDK v1.0 decision records
Reviewed against 1. Still open — Experimental tier definition excludes top-level
|

This PR:
docs/decisions/capturing the settled plan for a coordinated Composio SDK 1.0, indexed indocs/decisions/README.mdsdk-1.0-stability-contract.md: scope (core + providers in; CLI and utility packages out), stable vsexperimental.*tiers (Tool Router stabilized to stable, MCP stays experimental), coordinated milestone with independent version numbers, generated-client graduation, and the deprecation/rename-alias policycross-sdk-parity-policy.md: TypeScript as the reference implementation, the 1:1 naming rule and the@composio/google->@composio/geminirename, declared (n/a-by-design) provider divergence, Python sync + async, the sharedCOMPOSIO::error-code catalog, thevalidate:sdk-paritycheck, and the living parity matrixsdk-v0-to-v1-migration.md: final 0.x deprecation release, alias bridges through 1.x removed at 2.0, server-driven retirement ofconnected_accounts.initiate(), plus the codemod,v1-migrationskill, migration doc page, and docs version selectorvalidate:sdk-parity, the codemod, thev1-migrationskill); no SDK code changes hereStacked on #3666: review and merge that first, or review this against its base branch.