Skip to content

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

docs: add changelog for is_local_toolkit deprecation and is_local removal

Devin AI5e4577f7737c
diff --git a/fern/pages/src/changelog/12-16-25.md b/fern/pages/src/changelog/12-16-25.md
new file mode 100644
index 000000000..3c15827f1
--- /dev/null
+++ b/fern/pages/src/changelog/12-16-25.md
@@ -0,0 +1,81 @@
+# Deprecation of `is_local_toolkit` Field and Removal of `is_local` Query Parameter
+
+We're cleaning up the Toolkits API by deprecating the `is_local_toolkit` response field and removing the `is_local` query parameter filter.
+
+## What's Changing?
+
+### Response Field: `is_local_toolkit` (Deprecated)
+
+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.
+
+**Affected Endpoints:**
+- `GET /api/v3/toolkits` - List toolkits
+- `GET /api/v3/toolkits/{slug}` - Get single toolkit
+- `GET /api/v3/toolkits/multi` - Get multiple toolkits
+
+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.
+
+### Query Parameter: `is_local` (Removed)
+
+The `is_local` query parameter filter has been **removed** from the following endpoints:
+- `GET /api/v3/toolkits`
+- `GET /api/v3/toolkits/multi`
+
+This parameter was used to filter toolkits by their local status, but since no toolkits are classified as local, it served no practical purpose.
+
+## Why This Matters
+
+This cleanup:
+- **Simplifies the API**: Removes unused filtering options that could confuse developers
+- **Reduces Complexity**: Eliminates dead code paths in the backend
+- **Improves Documentation**: Makes the API surface cleaner and easier to understand
+
+## Impact on Your Code
+
+### If You're Using the `is_local` Query Parameter
+
+**Before:**
+```typescript
+// This will no longer work
+const toolkits = await fetch('/api/v3/toolkits?is_local=true');
+```
+
+**After:**
+```typescript
+// Simply remove the is_local parameter
+const toolkits = await fetch('/api/v3/toolkits');
+```
+
+### If You're Reading the `is_local_toolkit` Response Field
+
+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.
+
+**Before:**
+```typescript
+const toolkit = await composio.toolkits.get('github');
+if (toolkit.is_local_toolkit) {
+ // This condition will never be true
+ handleLocalToolkit(toolkit);
+}
+```
+
+**After:**
+```typescript
+const toolkit = await composio.toolkits.get('github');
+// Remove is_local_toolkit checks - they're no longer meaningful
+```
+
+## Migration Guide
+
+1. **Search your codebase** for any usage of `is_local` query parameter and remove it
+2. **Search for `is_local_toolkit`** field usage and remove any conditional logic based on it
+3. **Update any type definitions** if you've manually typed the toolkit response to expect meaningful values from this field
+
+## Timeline
+
+- **Effective immediately**: The `is_local` query parameter is no longer accepted
+- **Deprecated**: The `is_local_toolkit` response field will continue to return `false` indefinitely for backward compatibility
+
+## Questions?
+
+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).