IMPLEMENTATION
Call this tool
Connect a user's shipcloud account once, then configure and run Create Shipment 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: "shipcloud-create-shipment",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
shipcloud: { authProvisionId: "apn_xxxxxxx" },
carrier: "Carrier",
service: "Service",
},
})
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": "shipcloud-create-shipment",
"configured_props": {
"shipcloud": { "authProvisionId": "apn_xxxxxxx" },
"carrier": "Carrier",
"service": "Service"
}
}'// 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": "shipcloud",
},
},
},
)
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: "shipcloud-create-shipment",
arguments: {
carrier: "Carrier",
service: "Service",
},
})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 |
|---|---|---|
carrier Carrier | string | The carrier you want to use Required |
service Service | string | The service that should be used for the shipment Required |
toAddress Recipient Address | string | Select an Address from the list.
Alternatively, you can provide a custom JSON-stringified Address object. Example address object: {"company":"MusterCompany","first_name":"Max","last_name":"Mustermann","street":"Musterstraße","street_no":"42","zip_code":"54321","city":"Musterstadt"} Required Dynamic |
fromAddress Sender Address | string | Select an Address from the list.
Alternatively, you can provide a custom JSON-stringified Address object. Example address object: {"company":"MusterCompany","first_name":"Max","last_name":"Mustermann","street":"Musterstraße","street_no":"42","zip_code":"54321","city":"Musterstadt"} Required Dynamic |
package Package | object | Object describing the package. Required fields are height, length, weight and width.
(See more info on the Shipcloud Docs) Required |
additionalOptions Additional Options | object | Optional parameters to pass, such as description or notification_email (more info on the Shipcloud Docs) Optional |
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
- shipcloud-create-shipment
- Version
- 0.0.2
- App
- shipcloud
- Authentication
- API key
- Read-only
- No
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗