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 22, 17:00 UTC
docs: add changelog for is_local_toolkit deprecation and is_local removal
Co-Authored-By: rahul.lingala@composio.dev <lingalarahul7@gmail.com>
Devin AI committed
Dec 16, 2025 at 14:10 UTC
5e4577f7737c8051cef37b2a48a47708339224f3
1 file changed
+81
fern/pages/src/changelog/12-16-25.md
new
+81
@@ -0,0 +1,81 @@
1
+# Deprecation of `is_local_toolkit` Field and Removal of `is_local` Query Parameter
2
+
3
+We're cleaning up the Toolkits API by deprecating the `is_local_toolkit` response field and removing the `is_local` query parameter filter.
4
+
5
+## What's Changing?
6
+
7
+### Response Field: `is_local_toolkit` (Deprecated)
8
+
9
+The `is_local_toolkit` field in toolkit API responses is now **deprecated**. This field was originally intended to indicate whether a toolkit was local to a specific project, but it is no longer meaningful as no toolkits use this classification.
10
+
11
+**Affected Endpoints:**
12
+- `GET /api/v3/toolkits` - List toolkits
13
+- `GET /api/v3/toolkits/{slug}` - Get single toolkit
14
+- `GET /api/v3/toolkits/multi` - Get multiple toolkits
15
+
16
+The field will continue to be returned in API responses for backward compatibility, but it will always return `false`. It is marked as `deprecated: true` in the OpenAPI specification.
17
+
18
+### Query Parameter: `is_local` (Removed)
19
+
20
+The `is_local` query parameter filter has been **removed** from the following endpoints:
21
+- `GET /api/v3/toolkits`
22
+- `GET /api/v3/toolkits/multi`
23
+
24
+This parameter was used to filter toolkits by their local status, but since no toolkits are classified as local, it served no practical purpose.
25
+
26
+## Why This Matters
27
+
28
+This cleanup:
29
+- **Simplifies the API**: Removes unused filtering options that could confuse developers
30
+- **Reduces Complexity**: Eliminates dead code paths in the backend
31
+- **Improves Documentation**: Makes the API surface cleaner and easier to understand
32
+
33
+## Impact on Your Code
34
+
35
+### If You're Using the `is_local` Query Parameter
36
+
37
+**Before:**
38
+```typescript
39
+// This will no longer work
40
+const toolkits = await fetch('/api/v3/toolkits?is_local=true');
41
+```
42
+
43
+**After:**
44
+```typescript
45
+// Simply remove the is_local parameter
46
+const toolkits = await fetch('/api/v3/toolkits');
47
+```
48
+
49
+### If You're Reading the `is_local_toolkit` Response Field
50
+
51
+The field will continue to be present in responses but will always return `false`. You can safely ignore this field or remove any logic that depends on it.
52
+
53
+**Before:**
54
+```typescript
55
+const toolkit = await composio.toolkits.get('github');
56
+if (toolkit.is_local_toolkit) {
57
+ // This condition will never be true
58
+ handleLocalToolkit(toolkit);
59
+}
60
+```
61
+
62
+**After:**
63
+```typescript
64
+const toolkit = await composio.toolkits.get('github');
65
+// Remove is_local_toolkit checks - they're no longer meaningful
66
+```
67
+
68
+## Migration Guide
69
+
70
+1. **Search your codebase** for any usage of `is_local` query parameter and remove it
71
+2. **Search for `is_local_toolkit`** field usage and remove any conditional logic based on it
72
+3. **Update any type definitions** if you've manually typed the toolkit response to expect meaningful values from this field
73
+
74
+## Timeline
75
+
76
+- **Effective immediately**: The `is_local` query parameter is no longer accepted
77
+- **Deprecated**: The `is_local_toolkit` response field will continue to return `false` indefinitely for backward compatibility
78
+
79
+## Questions?
80
+
81
+If you have any questions about this change or need assistance with migration, please reach out to our support team or check our [Toolkits documentation](https://docs.composio.dev/docs/toolkits).