Skip to main content
Glama

get_inventory_report

Retrieve inventory reports from ShipBob's fulfillment API by specifying date ranges and optional fulfillment center filters to track stock levels and movement.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
startDateYesStart date for the report (YYYY-MM-DD)
endDateYesEnd date for the report (YYYY-MM-DD)
fulfillmentCenterIdNoFilter by fulfillment center ID

Implementation Reference

  • The handler function that executes the tool logic: prepares params, calls shipbobClient.getInventoryReport, returns JSON-formatted report or error.
    handler: async ({ startDate, endDate, fulfillmentCenterId }) => {
      try {
        const params = { startDate, endDate, fulfillmentCenterId };
        const report = await shipbobClient.getInventoryReport(params);
        return {
          content: [{ 
            type: "text", 
            text: JSON.stringify(report, null, 2)
          }]
        };
      } catch (error) {
        return {
          content: [{ type: "text", text: `Error retrieving inventory report: ${error.message}` }],
          isError: true
        };
      }
    }
  • Input schema using Zod for validating parameters: startDate (string), endDate (string), fulfillmentCenterId (optional string).
    schema: {
      startDate: z.string().describe("Start date for the report (YYYY-MM-DD)"),
      endDate: z.string().describe("End date for the report (YYYY-MM-DD)"),
      fulfillmentCenterId: z.string().optional().describe("Filter by fulfillment center ID")
    },
  • src/server.js:58-58 (registration)
    Registration of the reportingTools array (containing get_inventory_report) using the registerTools utility.
    registerTools(reportingTools);
  • Supporting method in ShipBobClient that makes the actual API request to '/reports/inventory'.
    async getInventoryReport(params) {
      return this.request('GET', '/reports/inventory', null, params);
    }
  • Tool metadata: name and description used during registration.
    name: "get_inventory_report",
    description: "Get inventory report from ShipBob",
Behavior1/5

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

Tool has no description.

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

Conciseness1/5

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

Tool has no description.

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

Completeness1/5

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

Tool has no description.

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

Parameters1/5

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

Tool has no description.

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

Purpose1/5

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

Tool has no description.

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

Usage Guidelines1/5

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

Tool has no description.

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

Install Server

Other Tools

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