Shipengine ACTION
Validate An Address
Address validation ensures accurate addresses and can lead to reduced shipping costs by preventing address correction surcharges. See the docs.
- Action
- Read only
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Shipengine account once, then configure and run Validate An Address 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: "shipengine-validate-address",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
shipengine: { authProvisionId: "apn_xxxxxxx" },
name: "Name",
phone: "Phone",
},
})
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": "shipengine-validate-address",
"configured_props": {
"shipengine": { "authProvisionId": "apn_xxxxxxx" },
"name": "Name",
"phone": "Phone"
}
}'// 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": "shipengine",
},
},
},
)
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: "shipengine-validate-address",
arguments: {
name: "Name",
phone: "Phone",
},
})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 |
|---|---|---|
name Name | string | The name of a contact person at this address. Optional |
phone Phone | string | The phone number of a contact person at this address. The format of this phone number varies depending on the country. Optional |
cityLocality City Or Locality | string | The name of the city or locality. Required |
stateProvince State Or Province | string | The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. Required |
countryCode Country Code | string | The two-letter ISO 3166-1 country code. Required |
addressLine1 Address Line 1 | string | The first line of the street address. For some addresses, this may be the only line. Other addresses may have two or three lines. Required |
addressLine2 Address Line 2 | string | The second line of the street address. Optional |
addressLine3 Address Line 3 | string | The third line of the street address. 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
- shipengine-validate-address
- Version
- 0.0.3
- App
- Shipengine
- Authentication
- API key
- Read-only
- Yes
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗