Skip to main content
Glama

get_inventory_levels

Retrieve current inventory levels from ShipBob's fulfillment system to monitor stock quantities and manage product availability across warehouses.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoPage number for pagination
limitNoNumber of items per page

Implementation Reference

  • The handler function that executes the tool logic: prepares params, calls shipbobClient.getInventoryLevels, returns formatted JSON or error response.
    handler: async ({ page, limit }) => {
      try {
        const params = { page, limit };
        const levels = await shipbobClient.getInventoryLevels(params);
        return {
          content: [{ 
            type: "text", 
            text: JSON.stringify(levels, null, 2)
          }]
        };
      } catch (error) {
        return {
          content: [{ type: "text", text: `Error retrieving inventory levels: ${error.message}` }],
          isError: true
        };
      }
    }
  • Zod schema defining optional input parameters: page and limit for pagination.
    schema: {
      page: z.number().optional().describe("Page number for pagination"),
      limit: z.number().optional().describe("Number of items per page")
    },
  • Tool definition object in inventoryTools array, which is imported and registered via server.tool() in server.js.
    {
      name: "get_inventory_levels",
      description: "Get current inventory levels for all products",
      schema: {
        page: z.number().optional().describe("Page number for pagination"),
        limit: z.number().optional().describe("Number of items per page")
      },
      handler: async ({ page, limit }) => {
        try {
          const params = { page, limit };
          const levels = await shipbobClient.getInventoryLevels(params);
          return {
            content: [{ 
              type: "text", 
              text: JSON.stringify(levels, null, 2)
            }]
          };
        } catch (error) {
          return {
            content: [{ type: "text", text: `Error retrieving inventory levels: ${error.message}` }],
            isError: true
          };
        }
      }
    },
  • ShipBobClient helper method that performs the actual API GET request to retrieve inventory levels.
    async getInventoryLevels(params) {
      return this.request('GET', '/inventory/levels', null, params);
    }
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