You can write and publish your own components to your Pipedream workspace to use with Connect. This complements the public actions available in Pipedream’s global registry.
Custom tools are Node.js modules that you develop using the Pipedream Components API and publish to your Pipedream workspace. Once published, they become available across all Connect APIs, including the list, retrieve, run endpoints, etc.
Publishing custom tools is available to Pipedream customers on the Business plan.
Custom tools use the same development workflow as standard Pipedream components:
Custom tools are actions. Check out the actions quickstart guide for step-by-step development instructions. Support for custom sources (triggers) is coming soon.
To make your custom components available in Connect, use the pd publish
command with the --connect-environment
flag:
The --connect-environment
flag accepts two values:
development
: makes the component available to your Pipedream workspace in Connect in developmentproduction
: makes the component available to your Pipedream workspace in Connect in productionComponents published to development
will only be available in the development environment, and vice versa for production
.
Once published, your custom tools appear alongside public components in Connect APIs:
Custom tools are identified with a ~/
prefix in their component ID. For example, if you publish a component with the key google_sheets-update-file
, it will appear in Connect APIs as ~/google_sheets-update-file
.
When making API calls to list, retrieve, or run custom tools, use the prefixed ID:
The Connect API treats custom tools identically to public components, ensuring a consistent integration experience.
Custom actions that you publish are automatically exposed as tools in the Pipedream MCP server for the relevant app.
Here’s a typical workflow for creating and using a custom tool:
Test your custom tools in your application directly or run Pipedream’s SDK playground locally with your Pipedream credentials.
For component development questions, visit the Pipedream Support. For Connect-specific integration help, refer to the Connect docs.