IMPLEMENTATION
Call this tool
Connect a user's Lob account once, then configure and run Create Letter 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: "lob-create-letter",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
lob: { authProvisionId: "apn_xxxxxxx" },
to: "To",
description: "Description",
},
})
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": "lob-create-letter",
"configured_props": {
"lob": { "authProvisionId": "apn_xxxxxxx" },
"to": "To",
"description": "Description"
}
}'// 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": "lob",
},
},
},
)
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: "lob-create-letter",
arguments: {
to: "To",
description: "Description",
},
})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 |
|---|---|---|
to To | string | Must either be an addressId or an inline object with correct address parameters Required Dynamic |
description Description | string | An internal description that identifies this resource Required |
from From | string | Required if to address is international. Must either be an addressId or an inline object with correct address parameters Required Dynamic |
name Name | string | Name of the recipient. Optional |
company Company | string | Company name associated with the recipient. Optional |
email Email | string | Email address of the recipient. Optional |
phone Phone | string | Phone number of the recipient. Optional |
addressLine1 Address Line 1 | string | First line of the address. Optional |
addressLine2 Address Line 2 | string | Second line of the address. Optional |
addressCity City | string | City of the address. Optional |
addressState State | string | State of the address. Optional |
addressZip ZIP Code | string | ZIP code of the address. Optional |
addressCountry Country | string | Country of the address. Optional |
file File | string | Letter content in HTML Required |
color Color | boolean | Set to true if you want to print in color; set to false for black and white. Required |
useType Use Type | string | The use type of the mail. It can only be null if an account default use_type is selected). Required |
mailType Mail Type | string | Designates the mail postage type. Optional |
sendDate Send Date | string | Specifies the date to send the letter off for production (ISO 8601 format, up to 180 days in the future). 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
- lob-create-letter
- Version
- 0.0.3
- App
- Lob
- Authentication
- API key
- Read-only
- No
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗