Skip to main content
Glama
VesselAPI MCP Server

VesselAPI MCP Server

get_port_events_by_vessel

Retrieve a vessel's port arrivals and departures, optionally filtered by event type and time window; defaults to the last 2 hours.

Instructions

Get port events (arrivals/departures) for a specific vessel. Covers only the last 2 hours unless timeFrom is given. Events are kept for 31 days.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "vesselId": "<vesselId>"
    },
    "name": "get_port_events_by_vessel"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoResults per page, 1 to 50. Defaults to 20.
idTypeNoIdentifier type: imo (default) or mmsi
timeToNoEnd of the time window, RFC3339. Defaults to now.
timeFromNoStart of the time window, RFC3339. Without it the service returns only the last 2 hours.
vesselIdYesVessel identifier (IMO number by default)
eventTypeNoFilter by event type. Omit for both arrivals and departures
nextTokenNoPagination token from previous response
sortOrderNoSort order by timestamp

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv2.2.0
    • removedInput schema / additionalProperties
      Removed value: -false
    • changedInput schema / properties / timeFrom / description
      Previous value: -"Start time (ISO 8601 format)"New value: +"Start of the time window, RFC3339. Without it the service returns only the last 2 hours."
    • changedInput schema / properties / timeTo / description
      Previous value: -"End time (ISO 8601 format)"New value: +"End of the time window, RFC3339. Defaults to now."
  2. Changed10 schema fields changedv2.0.0
    • changedInput schema / properties / eventType / description
      Previous value: -"Filter by event type (arrival, departure)"New value: +"Filter by event type. Omit for both arrivals and departures"
    • addedInput schema / properties / eventType / enum
      Added value: +[
      +  "arrival",
      +  "departure",
      +  "all"
      +]
    • changedInput schema / properties / idType / description
      Previous value: -"Identifier type: imo (default), mmsi, or vesselId"New value: +"Identifier type: imo (default) or mmsi"
    • addedInput schema / properties / idType / enum
      Added value: +[
      +  "imo",
      +  "mmsi"
      +]
    • changedInput schema / properties / limit / description
      Previous value: -"Max results per page"New value: +"Results per page, 1 to 50. Defaults to 20."
    • addedInput schema / properties / limit / maximum
      Added value: +50
    • addedInput schema / properties / limit / minimum
      Added value: +1
    • changedInput schema / properties / limit / type
      Previous value: -"number"New value: +"integer"
    • changedInput schema / properties / sortOrder / description
      Previous value: -"Sort order by timestamp (asc or desc)"New value: +"Sort order by timestamp"
    • addedInput schema / properties / sortOrder / enum
      Added value: +[
      +  "asc",
      +  "desc"
      +]
  3. Addedv1.3.0

TDQS

A3.6/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries the full behavioral burden. It discloses two meaningful traits: the default 2-hour window and the 31-day retention ceiling, which lets an agent reason about data availability. It says nothing about pagination behavior (beyond the schema's nextToken), result ordering defaults, or rate/permission constraints, and the 2-hour default partially restates the timeFrom schema text.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three short sentences, front-loaded with the core purpose and followed by the two temporal constraints. No filler, no redundancy, and every sentence conveys an actionable fact.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For an eight-parameter read tool with full schema coverage and no output schema, the description covers the essential unknown: the default and maximum temporal scope of the data. It omits result shape and how pagination terminates, but the schema's nextToken/limit fields mitigate that gap.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so all eight parameters including the enums for idType, eventType, and sortOrder are already documented in the schema; baseline is 3. The description adds no parameter-level semantics beyond echoing the timeFrom default window, so it does not exceed the schema's contribution.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Get port events') plus a scope qualifier ('for a specific vessel') and clarifies the event kinds (arrivals/departures). It does not differentiate itself from near-identical siblings such as search_port_events_by_vessel, list_port_events, or get_vessel_last_port_event, so an agent cannot fully disambiguate from the description alone.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The note that only the last 2 hours are returned unless timeFrom is given is genuinely useful invocation guidance, since it tells the agent it must supply timeFrom for historical lookups. However, there is no guidance on when to use this tool versus the several sibling event-listing tools, and no statement of prerequisites or exclusions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.