Skip to main content
The Terminal MCP server is in beta. Tool names and arguments may change. Please share feedback via our shared Slack channel or support@withterminal.com.
The MCP server exposes Terminal API read operations as Model Context Protocol tools. For setup steps, see the Agents guide.

​
Endpoint

​
Authentication

Clients authenticate with OAuth. When you add the server, your client opens a browser to sign in with your Terminal Dashboard account. You do not put a secret key (sk_…) in the client config. The server requests the openid, profile, email, user:org:read, and public_metadata scopes. The resulting token acts as your Dashboard user: every tool call is authorized against the applications in your active organization and the data that user can read.

​
Arguments

Each tool’s input schema is generated from the matching API operation. Query and path parameters become tool arguments with the same names. The server also accepts the following arguments, which it maps onto the request: The server’s instructions tell the agent to resolve applicationId and connectionToken before calling scoped tools, so you rarely need to provide them yourself.

​
Tools

Every tool is a GET against the Terminal API and is annotated readOnlyHint. The MCP server cannot create, update, or delete data. Tools map one-to-one to API operations, named by operation ID: for example, listVehicles is List Vehicles and listHOSLogs is List HOS Logs. Tools cover applications, connections, providers, vehicles and locations, drivers and HOS, trips, safety events, fault codes, devices, groups, trailers, IFTA, syncs, and issues. Ask your agent to list its tools for the current set. Tools return the API response body as JSON text. Paginated tools accept cursor and limit like the API; see Pagination.

​
Errors

A tool call that fails returns an MCP result with isError: true and a text message:
  • Invalid arguments. The arguments do not match the tool’s input schema. The message lists each failing field.
  • API errors. The Terminal API returned a non-2xx status. The message is Terminal API <status>: <response body>.

​
Rate limits

Tool calls are ordinary Terminal API requests and count toward the same rate limits. A 429 is returned to the agent as an API error.