Skip to main content
Glama

update_product

Modify product details in ShipBob's fulfillment system, including name, SKU, dimensions, weight, and description for accurate inventory management.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
productIdYesThe ID of the product to update
nameNoProduct name
skuNoStock keeping unit
barcodeNoProduct barcode/UPC
descriptionNoProduct description
weightNoWeight in ounces
lengthNoLength in inches
widthNoWidth in inches
heightNoHeight in inches
valueNoDeclared value of the product

Implementation Reference

  • The handler function that implements the core logic of the 'update_product' tool. It destructures the productId and spreads the rest as productData, calls the ShipBob API client to perform the update, and returns a formatted success or error response.
    handler: async ({ productId, ...productData }) => {
      try {
        const updatedProduct = await shipbobClient.updateProduct(productId, productData);
        return {
          content: [{ 
            type: "text", 
            text: `Product updated successfully: ${JSON.stringify(updatedProduct, null, 2)}`
          }]
        };
      } catch (error) {
        return {
          content: [{ type: "text", text: `Error updating product: ${error.message}` }],
          isError: true
        };
      }
    }
  • Zod schema defining the input parameters and validation for the 'update_product' tool.
    schema: {
      productId: z.string().describe("The ID of the product to update"),
      name: z.string().optional().describe("Product name"),
      sku: z.string().optional().describe("Stock keeping unit"),
      barcode: z.string().optional().describe("Product barcode/UPC"),
      description: z.string().optional().describe("Product description"),
      weight: z.number().optional().describe("Weight in ounces"),
      length: z.number().optional().describe("Length in inches"),
      width: z.number().optional().describe("Width in inches"),
      height: z.number().optional().describe("Height in inches"),
      value: z.number().optional().describe("Declared value of the product")
    },
  • The complete tool definition object for 'update_product', including name, description, schema, and handler. This object is part of the productTools array exported and registered in server.js via registerTools(productTools).
    {
      name: "update_product",
      description: "Update an existing product in ShipBob",
      schema: {
        productId: z.string().describe("The ID of the product to update"),
        name: z.string().optional().describe("Product name"),
        sku: z.string().optional().describe("Stock keeping unit"),
        barcode: z.string().optional().describe("Product barcode/UPC"),
        description: z.string().optional().describe("Product description"),
        weight: z.number().optional().describe("Weight in ounces"),
        length: z.number().optional().describe("Length in inches"),
        width: z.number().optional().describe("Width in inches"),
        height: z.number().optional().describe("Height in inches"),
        value: z.number().optional().describe("Declared value of the product")
      },
      handler: async ({ productId, ...productData }) => {
        try {
          const updatedProduct = await shipbobClient.updateProduct(productId, productData);
          return {
            content: [{ 
              type: "text", 
              text: `Product updated successfully: ${JSON.stringify(updatedProduct, null, 2)}`
            }]
          };
        } catch (error) {
          return {
            content: [{ type: "text", text: `Error updating product: ${error.message}` }],
            isError: true
          };
        }
      }
    }
  • Helper method in ShipBobClient that performs the actual PUT request to the ShipBob API /products/{id} endpoint, called by the tool handler.
    async updateProduct(id, productData) {
      return this.request('PUT', `/products/${id}`, productData);
    }
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