distance-matrix
Calculate travel distances and durations between multiple origin and destination points using various transportation modes including driving, walking, bicycling, and transit.
Instructions
Calculate travel distance and time between multiple origins and destinations
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| destinations | Yes | Array of destination locations | |
| mode | No | Travel mode | |
| origins | Yes | Array of origin locations |
Input Schema (JSON Schema)
{
"properties": {
"destinations": {
"description": "Array of destination locations",
"items": {
"type": "string"
},
"type": "array"
},
"mode": {
"description": "Travel mode",
"enum": [
"driving",
"walking",
"bicycling",
"transit"
],
"type": "string"
},
"origins": {
"description": "Array of origin locations",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"origins",
"destinations"
],
"type": "object"
}
Implementation Reference
- src/maps.ts:399-454 (handler)Main handler function for the 'distance-matrix' tool. Calls Google Maps Distance Matrix API, processes results into a list, formats as Markdown using helper, and returns structured content.export async function distanceMatrix( params: z.infer<typeof distanceMatrixSchema>, extra?: any ) { const apiKey = process.env.GOOGLE_MAPS_API_KEY; if (!apiKey) { throw new Error("GOOGLE_MAPS_API_KEY is required"); } try { const response = await googleMapsClient.distancematrix({ params: { origins: params.origins, destinations: params.destinations, mode: (params.mode || "driving") as any, key: apiKey, }, }); const rows = response.data.rows; const results = []; for (let i = 0; i < params.origins.length; i++) { for (let j = 0; j < params.destinations.length; j++) { const element = rows[i].elements[j]; results.push({ origin: params.origins[i], destination: params.destinations[j], distance: element.distance?.text || "N/A", duration: element.duration?.text || "N/A", status: element.status, }); } } return { content: [ { type: "text" as const, text: formatDistanceMatrixToMarkdown(results), }, ], }; } catch (error) { return { content: [ { type: "text" as const, text: `Error calculating distance matrix: ${ error instanceof Error ? error.message : String(error) }`, }, ], }; } }
- src/maps.ts:132-139 (schema)Zod schema defining input parameters for the distance-matrix tool: origins array, destinations array, optional mode.export const distanceMatrixSchema = z.object({ origins: z.array(z.string()).describe("Array of origin locations"), destinations: z.array(z.string()).describe("Array of destination locations"), mode: z .enum(["driving", "walking", "bicycling", "transit"]) .optional() .describe("Travel mode"), });
- src/index.ts:100-107 (registration)Registration of the 'distance-matrix' tool on the MCP server, using the schema and handler from maps.ts.server.tool( "distance-matrix", "Calculate travel distance and time between multiple origins and destinations", distanceMatrixSchema.shape, async (params) => { return await distanceMatrix(params); } );
- src/maps.ts:55-66 (helper)Helper function to format distance matrix results into Markdown for the response.function formatDistanceMatrixToMarkdown(results: any[]): string { let markdown = `# Distance Matrix Results\n\n`; results.forEach((result, index) => { markdown += `## ${index + 1}. ${result.origin} → ${result.destination}\n`; markdown += `Distance: ${result.distance} \n`; markdown += `Duration: ${result.duration} \n`; markdown += `Status: ${result.status} \n\n`; }); return markdown; }