View as Markdown
Mapbox icon

Mapbox ACTION

Generate Directions

Generates directions between two or more locations using Mapbox API. See the documentation.
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Mapbox account once, then configure and run Generate Directions 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: "mapbox-generate-directions",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    mapbox: { authProvisionId: "apn_xxxxxxx" },
    startCoordinate: "Start Coordinate",
    endCoordinate: "End Coordinate",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Generate Directions inputs
Property Type Description
startCoordinate Start Coordinate string
The starting point in the format longitude,latitude, E.g. -85.244869,37.835819
Required
endCoordinate End Coordinate string
The ending point in the format longitude,latitude, E.g. -85.244869,37.835819
Required
transportationMode Transportation Mode string
The mode of transportation
Required
steps Steps boolean
Whether to return steps and turn-by-turn instructions (true) or not (false, default)
Optional
alternatives Alternatives boolean
Whether to try to return alternative routes (true) or not (false, default). An alternative route is a route that is significantly different from the fastest route, but still close in time.
Optional
exclude Exclude string[]
Exclude certain road types and custom locations from routing
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
mapbox-generate-directions
Version
0.0.3
App
Mapbox
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes