Skip to main content
Glama

get_shipment

Retrieve shipment details from the ShipBob fulfillment API using a specific shipment ID to track order status and fulfillment information.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
shipmentIdYesThe ID of the shipment to retrieve

Implementation Reference

  • The handler function that implements the core logic of the 'get_shipment' tool. It fetches the shipment data via the ShipBob API client and returns it as formatted JSON, handling errors appropriately.
    handler: async ({ shipmentId }) => {
      try {
        const shipment = await shipbobClient.getShipment(shipmentId);
        return {
          content: [{ 
            type: "text", 
            text: JSON.stringify(shipment, null, 2)
          }]
        };
      } catch (error) {
        return {
          content: [{ type: "text", text: `Error retrieving shipment: ${error.message}` }],
          isError: true
        };
      }
    }
  • The Zod input schema for the 'get_shipment' tool, defining the required shipmentId parameter.
    schema: {
      shipmentId: z.string().describe("The ID of the shipment to retrieve")
    },
  • src/server.js:23-32 (registration)
    The registerTools function used to register all tools from arrays like fulfillmentTools, including 'get_shipment', by calling server.tool() for each.
    const registerTools = (toolsArray) => {
      toolsArray.forEach(tool => {
        server.tool(
          tool.name,
          tool.schema,
          tool.handler,
          { description: tool.description }
        );
      });
    };
  • src/server.js:53-53 (registration)
    Specific call to register the fulfillmentTools array, which includes the 'get_shipment' tool.
    registerTools(fulfillmentTools);
  • The ShipBobClient.getShipment method called by the tool handler to perform the actual API request for shipment details.
    async getShipment(id) {
      return this.request('GET', `/shipments/${id}`);
    }

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/mattcoatsworth/shipbob-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server