diff --git a/docs/Clarify the Usage of `Custom Functions` vs. `Tools`.md b/docs/Clarify the Usage of `Custom Functions` vs. `Tools`.md new file mode 100644 index 000000000..fc7c1e58e --- /dev/null +++ b/docs/Clarify the Usage of `Custom Functions` vs. `Tools`.md @@ -0,0 +1,29 @@ + +# Migrating from Custom Functions to Tools + +This document provides a comprehensive guide for migrating from the deprecated `Custom Functions` feature to the more powerful and flexible `Tools` feature. This migration is crucial for ensuring the continued functionality and future-proofing of your applications. + +## Why Migrate to Tools? + +`Custom Functions` are now deprecated in favor of `Tools`. `Tools` offer several advantages: + +* **Enhanced Flexibility:** Tools provide a more structured and versatile way to integrate external functionalities. +* **Improved Maintainability:** The `Tools` architecture promotes better code organization and easier maintenance. +* **Future-Proofing:** `Tools` are the recommended and actively developed approach for extending the capabilities of the platform. +* **Better Integration:** Tools are designed to integrate seamlessly with the platform's features, offering a more cohesive development experience. + +## Migration Path + +The migration process involves the following steps: + +1. **Understanding the Differences:** Familiarize yourself with the key differences between `Custom Functions` and `Tools`. +2. **Identifying Custom Function Usage:** Locate all instances where `Custom Functions` are used in your application. +3. **Reimplementing as Tools:** Rewrite your `Custom Functions` as `Tools`, leveraging the new architecture and capabilities. +4. **Testing and Validation:** Thoroughly test the migrated code to ensure functionality and compatibility. +5. **Deployment:** Deploy the updated application with the `Tools` implementation. + +## Step-by-Step Instructions + +### 1. Understanding the Differences + +| Feature | Custom Functions | Tools \ No newline at end of file