# Route4Me MCP

> Route4Me connects your entire logistics stack—address books, fleet status, and complex route optimizations—directly to your AI agent. Instead of exporting CSVs or clicking through clunky web portals, you talk to your agent and it executes tools like `create_address`, lists available vehicles via `get_vehicles`, or pulls the last 10 optimization runs using `get_optimizations`. It handles all routing data from a conversational interface.

## Overview
- **Category:** erp-operations
- **Price:** Free
- **Tags:** route-optimization, fleet-management, address-management, vrp-algorithms, logistics-automation, vehicle-tracking

## Description

Listen up. This isn't another dashboard you gotta click through.

Route4Me connects your whole logistics operation—your customer list, what vehicles are running, and all those complicated route plans—right to your AI agent. You don't export CSVs or wrestle with clunky web portals; you just talk to your agent, and it executes the tools for ya. Here’s what you can do.

**Managing Your Customer Addresses**
You wanna handle addresses? It's simple. You can add a brand new customer location using `create_address`. If you need to modify something—say, a phone number or an apartment unit—you just call `update_address` and tell it which fields are off. Got an address ID and just need the details? Use `get_address`. Need to pull up every single record in your whole book for a massive review? Call `get_addresses`. If a customer moved, you can wipe out that old location entirely with `delete_address`.

**Checking Your Fleet and Personnel**
You gotta know what resources you're running on. You can get an immediate rundown of every vehicle registered in your fleet by calling `get_vehicles`, so you always know exactly what's available to move product. Need to check who's driving? Use `get_users` to pull a list of all associated drivers and accounts tied to the system.

**Handling Routes**
When it comes to actual routes, your agent handles everything. You can ask for a complete listing of every saved vehicle plan using `get_routes`. If you know the ID of a specific route—say, the delivery run scheduled for Tuesday—you pull up all its details instantly with `get_route`.

**Auditing and History**
You gotta keep tabs on how things went. You can retrieve a full history of past optimization runs using `get_optimizations`. This lets you review results from previous trips, checking performance trends without ever having to touch the main dashboard or download an Excel file. It’s all conversational.

When your agent executes these tools—whether it's pulling up every single address with `get_addresses`, listing available trucks via `get_vehicles`, or digging into a specific route plan using `get_route`—it handles the routing data straight from natural conversation. You never gotta jump between pages or fill out ten forms; your agent just makes it happen.

## Tools

### get_address
Fetches the details for a single customer address using its unique ID.

### get_addresses
Lists all addresses currently stored in your Route4Me account book.

### get_optimizations
Retrieves a history of past route optimization runs and their results.

### get_route
Fetches the specific details for one existing vehicle route using its ID.

### get_routes
Lists all vehicle routes that are currently saved in your system.

### get_users
Retrieves a list of all associated users or drivers tied to the accounts.

### get_vehicles
Provides a current list of every vehicle registered and available in your fleet.

### create_address
Adds a brand new customer address record into your Route4Me book.

### delete_address
Removes an existing, specified address from the system.

### update_address
Modifies specific fields for an existing customer address record.

## Prompt Examples

**Prompt:** 
```
List all active vehicles assigned to my fleet.
```

**Response:** 
```
Checking your Route4Me profile... Here are your fleet vehicles:
1. 2020 Ford Transit (ID: xyz)
2. 2018 Toyota Van (ID: abc)
```

**Prompt:** 
```
Fetch the latest route optimizations.
```

**Response:** 
```
I've pulled the 10 most recent optimizations from Route4Me. Most recent ID: ABCDEF1234, encompassing 40 stops.
```

**Prompt:** 
```
Add a new address coordinate to the book.
```

**Response:** 
```
Done! Customer record inserted successfully into your Route4Me address book.
```

## Capabilities

### Manage Customer Addresses
Create, retrieve, update, or delete specific customer addresses using `create_address`, `get_address`, and `update_address`.

### Audit Route History
Fetch reports detailing past optimization runs with the `get_optimizations` tool, allowing for performance trend analysis.

### Check Fleet and User Status
List all registered vehicles via `get_vehicles` or list associated drivers using `get_users`, giving immediate visibility into resource availability.

### Retrieve Specific Routes
Pull details on a single route by ID (`get_route`) or get a full list of existing vehicle routes (`get_routes`).

### Bulk Address Retrieval
List every address stored in your Route4Me address book using `get_addresses` for bulk review.

## Use Cases

### Onboarding a New Client
A sales rep closes a deal and needs the route planned. Instead of emailing a spreadsheet, they ask their agent to 'Add the new client at 45 Oak Lane.' The agent runs `create_address`, populating the address book instantly so the next day's routes can include it.

### Pre-Dispatch Audit
It’s morning. A dispatcher needs to know if enough vans are available for a major job. They prompt their agent: 'What vehicles are currently registered?' The agent runs `get_vehicles` and returns the exact list, allowing immediate confirmation of fleet capacity.

### Troubleshooting Route Issues
A delivery failed because the route wasn't optimized correctly. Instead of digging through logs, the analyst asks: 'What were the results from last Tuesday's optimization?' The agent runs `get_optimizations` and hands back the necessary historical data for review.

### Mass Data Correction
The company moved a major client. Instead of finding that record in every system, the operations lead asks the agent to 'Update the coordinates for Acme Corp.' The agent runs `update_address` using the specific ID, ensuring data consistency across all systems.

## Benefits

- Instantly check vehicle availability. Instead of logging into a separate dashboard, just ask the agent to run `get_vehicles` or `get_users`, and you get a clean list of what's ready to go.
- Stop exporting CSV files for address updates. Use `create_address` or `update_address` directly through your chat window; the record hits the database instantly.
- Analyze performance history without leaving your workflow. Call `get_optimizations` and immediately compare last week's route runs against this month's results.
- Get full visibility into your current fleet status. The agent can list all vehicles via `get_vehicles`, saving you from manual dashboard checks when planning a run.
- No more guesswork on customer locations. Use `get_addresses` or `get_address` to verify coordinates and details before dispatching any driver.

## How It Works

The bottom line is, your agent talks to Route4Me directly, skipping the web UI entirely and getting clean JSON data for every action.

1. Sign up for a Route4Me account and copy your API Token from the Developer/API settings.
2. Input that API Key directly into the Vinkius vault to authorize access.
3. Your AI agent can now execute specific tools—like asking it to 'List all vans' or 'Add 123 Main Street'—and receive structured data back.

## Frequently Asked Questions

**How do I add a new customer address using create_address?**
You pass the necessary details (street, city, ID) in JSON format. The agent executes `create_address` and confirms insertion into your book.

**Can get_vehicles list my entire current fleet capacity?**
Yes, running `get_vehicles` pulls the full registered count of vehicles from your system, giving you an immediate inventory check for dispatch planning.

**What data is available with get_optimizations?**
The tool retrieves a history of optimization runs. You can use this to track changes in route length or stop count over time by analyzing the report IDs.

**Should I use get_address or get_addresses?**
Use `get_address` when you know the specific ID of the address you need. Use `get_addresses` if you want a full list of all addresses in your book.

**Does update_address require an existing record?**
Yes, `update_address` modifies data and requires the ID of an address that already exists in the system. You can use `get_addresses` first to find that ID.

**What credentials does the `get_vehicles` tool require to access fleet data?**
It needs a valid API Token stored in your Vinkius vault. This token must have read permissions for vehicle records and optimization history. If the token is expired or lacks scope, the call will fail immediately.

**If I use `get_address`, what happens if the provided address ID doesn't exist?**
The API returns a specific error code (404) and an empty payload. Your agent should check for this explicit failure status before attempting to process or display any data.

**When calling `get_addresses`, how do I filter the results by state or zip code?**
You must pass filtering parameters, like a state abbreviation or ZIP range, within the tool's request body. The API processes these filters and only returns addresses matching those criteria.

**Can the agent trigger a new algorithm calculation?**
Currently, the agent is restricted to retrieving existing optimization histories and reading paths to ensure API limits are protected. Address book creations are however supported.

**Is the API key secure across requests?**
Yes. The API key is securely appended to standard HTTPS queries locally during execution time.

**What addresses are retrieved from the book?**
The tool fetches the most recent addresses but allows passing a dynamic parameter to iterate through larger chunks of your system.