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

next
mdx 67 lines 2.24 KB
Raw
1 ---
2 title: "Deprecation of is_local_toolkit Field and Removal of is_local Query Parameter"
3 description: "Cleaning up the Toolkits API by removing unused local toolkit fields"
4 date: "2025-12-16"
5 ---
6
7 We're cleaning up the Toolkits API by deprecating the `is_local_toolkit` response field and removing the `is_local` query parameter filter.
8
9 ### What's Changing?
10
11 #### Response Field: `is_local_toolkit` (Deprecated)
12
13 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.
14
15 **Affected Endpoints:**
16 - `GET /api/v3/toolkits` - List toolkits
17 - `GET /api/v3/toolkits/{slug}` - Get single toolkit
18 - `GET /api/v3/toolkits/multi` - Get multiple toolkits
19
20 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.
21
22 #### Query Parameter: `is_local` (Removed)
23
24 The `is_local` query parameter filter has been **removed** from the following endpoints:
25 - `GET /api/v3/toolkits`
26 - `GET /api/v3/toolkits/multi`
27
28 This parameter was used to filter toolkits by their local status, but since no toolkits are classified as local, it served no practical purpose.
29
30 ### Impact on Your Code
31
32 #### If You're Using the `is_local` Query Parameter
33
34 **Before:**
35 ```typescript
36 // @noErrors
37 // This will no longer work
38 const toolkits = await fetch('/api/v3/toolkits?is_local=true');
39 ```
40
41 **After:**
42 ```typescript
43 // @noErrors
44 // Simply remove the is_local parameter
45 const toolkits = await fetch('/api/v3/toolkits');
46 ```
47
48 #### If You're Reading the `is_local_toolkit` Response Field
49
50 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.
51
52 **Before:**
53 ```typescript
54 // @noErrors
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 // @noErrors
65 const toolkit = await composio.toolkits.get('github');
66 // Remove is_local_toolkit checks - they're no longer meaningful
67 ```