Shorten.REST ACTION
Shorten Link
Shortens a given long URL into an alias. If the alias name is not provided, the system generates one. If the domain input is not provided, it defaults to short.fyi. See the documentation
- Action
- Writes data
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Shorten.REST account once, then configure and run Shorten Link from your backend or agent.
import { PipedreamClient } from "@pipedream/sdk"
const pd = new PipedreamClient({
projectId: process.env.PIPEDREAM_PROJECT_ID!,
clientId: process.env.PIPEDREAM_CLIENT_ID!,
clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
projectEnvironment: "production",
})
const result = await pd.actions.run({
id: "shorten_rest-short-link",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
shorten_rest: { authProvisionId: "apn_xxxxxxx" },
domainName: "Domain Name",
aliasName: "Alias Name",
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "shorten_rest-short-link",
"configured_props": {
"shorten_rest": { "authProvisionId": "apn_xxxxxxx" },
"domainName": "Domain Name",
"aliasName": "Alias Name"
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "shorten_rest",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "shorten_rest-short-link",
arguments: {
domainName: "Domain Name",
aliasName: "Alias Name",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
domainName Domain Name | string | The domain which alias will belong to (string without http/https or /). Eg. your.domain.com. Defaults to short.fyi Optional |
aliasName Alias Name | string | Alias (without / at the beginning). Eg. aBcDe012. Defaults to @rnd Optional |
destinations Destinations | string[] | Array of objects (DestinationModel). Where each row should be a JSON object like this: {"url": "mydomain.com"}. Please read the docs here Required |
REFERENCE
Tool details
Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.
- Registry key
- shorten_rest-short-link
- Version
- 0.0.3
- App
- Shorten.REST
- Authentication
- API key
- Read-only
- No
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗