diff --git a/build/tools/tool-library.mdx b/build/tools/tool-library.mdx new file mode 100644 index 00000000..89cddf92 --- /dev/null +++ b/build/tools/tool-library.mdx @@ -0,0 +1,63 @@ +--- +title: 'Tool Library' +description: 'Browse, search, and filter existing tools in your project to discover cloneable tools, embeddable tools, and tools that may benefit from migration to native integrations.' +--- + +The Tool Library is a browsable catalog of all tools in your project. Use it to discover existing tools, find ones you can clone or embed, and identify tools that contain legacy integration steps that could be migrated to newer native alternatives. + +## Accessing the Tool Library + +You can open the Tool Library from several places in the product: + +- **Agent settings** — when adding tools to an agent, click **+ Add tool** to open the library. +- **Tool builder** — browse existing tools before starting a new one. +- **Tools page** — the main tools listing in the left-hand menu. + +## Searching for tools + +The search bar at the top of the Tool Library lets you find tools by name or description. As you type, the list narrows to matching results. Search is case-insensitive and matches partial strings, so searching "slack" will surface any tool with "slack" in the name or description. + +## Filtering your tools + +The Tool Library includes filter options to help you narrow down which tools are shown. Select one filter at a time — with no filter active, all tools in the project are shown. + +- **Cloneable tools** — shows tools that have been made cloneable. Cloneable tools can be copied into another project, which is useful for sharing templates across teams or reusing tools in a new context. +- **Embeddable tools** — shows tools that have been made embeddable. Embeddable tools can be surfaced in external interfaces, such as a widget or custom UI, outside of Relevance AI. +- **Contains legacy tool-steps** — shows tools that include older Pipedream-based integration steps where a native replacement is now available. See [Legacy tool-steps](#legacy-tool-steps) below for details. + +## Legacy tool-steps + +Legacy tool-steps are integration steps that were built on top of Pipedream. Relevance AI now provides native integrations for many of these services, which are built and maintained directly by the platform and offer improved reliability and performance. + +The **Contains legacy tool-steps** filter surfaces any tool marked as containing at least one of these older steps. This gives you a clear starting point for auditing your tools and planning migration to native alternatives. + + +Bookmark the filtered URL or share it with teammates to give your team a quick view of tools that need attention. + + +### Why migrate legacy steps? + +Native integration steps offer several advantages over their Pipedream-based counterparts: + +- More reliable execution with fewer external dependencies +- Closer integration with agent triggers and tool configuration +- Ongoing support and updates from the Relevance AI team + +### How to migrate + +1. Use the **Contains legacy tool-steps** filter to identify affected tools. +2. Open each tool and locate the steps flagged as legacy. +3. Replace each legacy step with the equivalent native tool step from the **+ Add step** menu. +4. Test the tool to confirm behavior is unchanged. + +For a full overview of the difference between native and Pipedream integrations, see [Integrations](/integrations/introduction). + +## URL bookmarking + +Applying a filter updates the page URL with a query parameter, for example: + +- `?filter=containsLegacy` +- `?filter=cloneable` +- `?filter=embeddable` + +You can bookmark these URLs or share them with team members to jump directly to a filtered view — useful when coordinating a migration effort or reviewing a specific subset of tools. diff --git a/build/tools/tool-steps/getting-started.mdx b/build/tools/tool-steps/getting-started.mdx index c029f8d6..6ff1c1ad 100644 --- a/build/tools/tool-steps/getting-started.mdx +++ b/build/tools/tool-steps/getting-started.mdx @@ -13,6 +13,8 @@ For example, Relevance support variety analysis steps with all the requirement all taken care of. All you need to do is to add the suitable step component to your Tool. +Before building a new tool, you can browse existing tools in the [Tool Library](/build/tools/tool-library) to discover tools you can clone or learn from. + ## Creating a Tool and adding Tool steps The easiest way to get started with creating a tool is to start at the diff --git a/docs.json b/docs.json index 64bda239..cd048296 100644 --- a/docs.json +++ b/docs.json @@ -183,6 +183,7 @@ { "group": "Tools", "pages": [ + "build/tools/tool-library", "build/tools/create-a-tool", { "group": "Build a Tool", @@ -391,6 +392,7 @@ "pages": [ "integrations/introduction", "integrations/add-integrations", + "integrations/migrate-legacy-integrations", "integrations/remove-integrations" ] }, diff --git a/integrations/add-integrations.mdx b/integrations/add-integrations.mdx index 238ac97d..3e8aabe9 100644 --- a/integrations/add-integrations.mdx +++ b/integrations/add-integrations.mdx @@ -10,6 +10,10 @@ The **Integrations & API Keys** browser displays all available integrations. Use ## Setting Up Integrations + +If a tool you're working with has a legacy Pipedream-based integration, a migration banner will appear on its configuration page. See [Migrate legacy integrations](/integrations/migrate-legacy-integrations) to learn how to upgrade it to a native integration. + + To begin using integrations with your AI agents: 1. Navigate to the **Integrations & API Keys** page from the left-hand menu of your Relevance AI account. diff --git a/integrations/introduction.mdx b/integrations/introduction.mdx index 29670704..fffb01b7 100644 --- a/integrations/introduction.mdx +++ b/integrations/introduction.mdx @@ -28,6 +28,10 @@ Integrations fall into two types: Start with native integrations when available — they come with ready-made actions and triggers that require less configuration. + +If you have existing tools built with legacy Pipedream-based integrations, use the **Contains legacy tool-steps** filter in the [Tool Library](/build/tools/tool-library) to find them, then upgrade them with the [migration wizard](/integrations/migrate-legacy-integrations). + + ## 1. Connecting Integrations The first step in leveraging integrations is connecting your external services to Relevance AI: diff --git a/integrations/migrate-legacy-integrations.mdx b/integrations/migrate-legacy-integrations.mdx new file mode 100644 index 00000000..bea758df --- /dev/null +++ b/integrations/migrate-legacy-integrations.mdx @@ -0,0 +1,81 @@ +--- +title: 'Migrate legacy integrations' +description: 'Use the migration wizard to upgrade tools from Pipedream-based integrations to native integrations.' +sidebarTitle: 'Migrate legacy integrations' +--- + +## Overview + +Legacy tool integrations are tools that connect to external services using Pipedream-based transformations. These were created before Relevance AI introduced native integrations, and they rely on Pipedream as an intermediary layer to handle authentication and API calls. + +Native integrations are built directly by Relevance AI and offer several improvements over Pipedream-based ones: + + + + Native integrations communicate directly with external services, reducing latency and improving reliability. + + + Native integrations come with ready-made tool steps so you can get started without manual configuration. + + + Native integrations support trigger events that can automatically activate your agents when something happens in a connected platform. + + + Native integrations are maintained by the Relevance AI team, so issues are resolved faster. + + + + + The migration wizard is rolling out gradually to eligible tools. If your tool has a legacy Pipedream-based integration, you may see the migration banner on its configuration page. + + +## When you'll see the migration banner + +If you have a tool that uses a legacy Pipedream-based transformation, a banner notification will appear at the top of that tool's configuration page. The banner indicates that a native integration is now available for that service. + +Click the banner to open the migration wizard modal. The wizard guides you through the migration process step by step and does not require any manual re-configuration of your tool settings. + +## Migration process + + + + The wizard first prompts you to connect your account for the native integration. Click **Connect account** to be redirected to the third-party service's authentication page. Grant the necessary permissions, then you'll be redirected back to the wizard to continue. + + If you have already connected a native integration account for this service on your **Integrations & API Keys** page, the wizard may allow you to select that existing connection instead. + + + + The wizard displays a side-by-side comparison of your current Pipedream-based configuration and the equivalent native integration configuration. Review how your existing parameters map to the new integration's fields. + + Check that all settings carry over correctly before proceeding. If a parameter does not have a direct equivalent, the wizard will indicate this so you can decide how to handle it. + + + + Once you've reviewed the parameter mapping, click **Complete migration** to finalize the process. Your tool will be updated to use the native integration, and the legacy Pipedream transformation will be replaced. + + + +## After migration + +After the migration completes, test your tool to confirm it behaves as expected. Run it with representative inputs and verify the outputs match what you'd receive before migration. + +Your existing tool run history is preserved. Agents that use the tool continue to work without requiring reconfiguration — the migration updates the tool's underlying integration while keeping its interface and parameters intact. + +The tool now has access to all features available in the native integration, including any pre-built actions and trigger events added in the future. + +## Frequently asked questions (FAQs) + + + + The migration wizard maps your existing Pipedream-based parameters to their native integration equivalents. The wizard shows you this mapping before you finalize the migration, so you can review any differences. Your tool's name, description, and overall structure remain unchanged. + + + Migration is applied at the tool level, not the agent level. During the migration process, avoid running the tool until the migration is complete. Once finished, your agents can use the tool immediately — no changes to your agent configuration are needed. + + + Migrations cannot be reversed automatically. If you need to revert to the previous Pipedream-based integration, contact the [Relevance AI support team](/get-started/support) for assistance. + + + If the wizard encounters a problem — such as an authentication failure or an unmappable parameter — it will display an error message explaining what went wrong. You can retry the relevant step or reach out to the [Relevance AI support team](/get-started/support) for help. + +