@devries-cameron20 / composio Mirror · read-only
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

next
md 138 lines 4.44 KB
Rendered Raw
1 # API Update Command
2
3 Check for open PRs in the Composio client repositories and create a plan for updating the SDKs.
4
5 ## Workflow
6
7 ### Step 1: Check for Open PRs
8
9 Fetch open PRs from both client repositories:
10
11 1. **TypeScript Client**: `github.com/composiohq/composio-base-ts`
12 2. **Python Client**: `github.com/composiohq/composio-base-py`
13
14 Use the GitHub CLI (`gh`) to list open PRs:
15 ```bash
16 gh pr list --repo composiohq/composio-base-ts --state open --json number,title,url,headRefName,body
17 gh pr list --repo composiohq/composio-base-py --state open --json number,title,url,headRefName,body
18 ```
19
20 ### Step 2: Get PR Patches
21
22 For each open PR, fetch the diff/patch to understand the changes:
23 ```bash
24 gh pr diff <PR_NUMBER> --repo composiohq/composio-base-ts
25 gh pr diff <PR_NUMBER> --repo composiohq/composio-base-py
26 ```
27
28 ### Step 3: Analyze Changes
29
30 For each PR, analyze the diff to identify:
31
32 1. **New API endpoints** - New methods/functions added to the client
33 2. **Modified parameters** - Changes to existing function signatures
34 3. **Deprecated endpoints** - Removed or deprecated functionality
35 4. **Type changes** - Updates to type definitions/schemas
36 5. **Breaking changes** - Any backward-incompatible changes
37
38 ### Step 4: Identify SDK Impact
39
40 Map client changes to SDK files that need updates:
41
42 **TypeScript SDK (`@composio/core`)**:
43 - Check `ts/packages/core/src/` for affected code
44 - Types: `ts/packages/core/src/types/`
45 - Models: `ts/packages/core/src/models/`
46 - Services: `ts/packages/core/src/services/`
47
48 > **Important - Naming Convention for TypeScript:**
49 > The API uses **kebab-case** (e.g., `connected-accounts`, `auth-configs`, `tool-router`) but the TypeScript SDK uses **camelCase** (e.g., `connectedAccounts`, `authConfigs`, `toolRouter`).
50 >
51 > When mapping API changes to TypeScript SDK:
52 > - Convert all kebab-case parameter names to camelCase
53 > - Convert all kebab-case property names to camelCase
54 > - Keep the original kebab-case names in comments for reference to the API
55 > - Example: API's `callback_url` or `callback-url` becomes `callbackUrl` in TypeScript
56
57 **Python SDK (`composio`)**:
58 - Check `python/composio/` for affected code
59 - Types and models in `python/composio/core/`
60 - Python typically uses snake_case which often matches API naming
61
62 ### Step 5: Check Current Client Versions
63
64 Current client dependency versions:
65 - **TypeScript**: Check `pnpm-workspace.yaml` catalog for `@composio/client` version
66 - **Python**: Check `python/pyproject.toml` for `composio-client` version
67
68 ### Step 6: Create Update Plan
69
70 Create a plan document in `.agent_cache/` folder with the following structure:
71
72 ```
73 .agent_cache/
74 └── api-update-plan-<YYYY-MM-DD>.md
75 ```
76
77 ## Plan Document Structure
78
79 The plan document should contain:
80
81 ### 1. PR Summary
82 - List all open PRs with their numbers, titles, and URLs
83 - Brief description of what each PR changes
84
85 ### 2. Client Version Updates
86 - Current versions of both clients
87 - Target versions (from PR branch or proposed release)
88 - Files to update:
89 - `pnpm-workspace.yaml` (catalog section for `@composio/client`)
90 - `python/pyproject.toml` (dependencies section for `composio-client`)
91
92 ### 3. TypeScript SDK Changes
93 For each change needed:
94 - File path
95 - Change description
96 - Code snippet showing before/after (if applicable)
97 - Whether it's a breaking change
98 - **Naming mapping**: Show the API name (kebab-case/snake_case) → TypeScript name (camelCase)
99 - Example: `callback_url` → `callbackUrl`
100 - Example: `connected-account-id` → `connectedAccountId`
101
102 ### 4. Python SDK Changes
103 For each change needed:
104 - File path
105 - Change description
106 - Code snippet showing before/after (if applicable)
107 - Whether it's a breaking change
108
109 ### 5. Breaking Changes Summary
110 - List all breaking changes
111 - Migration steps required
112 - Affected public APIs
113
114 ### 6. Test Updates Required
115 - New tests to add
116 - Existing tests to update
117
118 ### 7. Documentation Updates
119 - API documentation changes needed
120 - Changelog entries to create
121
122 ## Important Notes
123
124 - **DO NOT** apply any changes to the codebase
125 - Only create the plan document in `.agent_cache/`
126 - Wait for user confirmation before proceeding with any changes
127 - If no open PRs are found, report that and exit
128 - If PRs exist but have no SDK-impacting changes, note that in the plan
129
130 ## Example Output Path
131
132 `.agent_cache/api-update-plan-2026-01-22.md`
133
134 ## Error Handling
135
136 - If `gh` CLI is not authenticated, prompt user to run `gh auth login`
137 - If repositories are not accessible, report the error
138 - If PR diff is too large, summarize key changes only