Skip to main content
Glama

set_inventory_item_custom_field

Sets (creates or updates) a custom field value on an inventory item. Provide the inventory item id, the field name (an existing field with that name is reused, otherwise a new field is created for the company), and the value. showInTable is a per-field, company-wide setting: true shows the field as a column in the inventory table for every item, false hides it. Returns the saved field.

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": {
      "inventoryItemId": "<inventoryItemId>",
      "fieldName": "<fieldName>",
      "value": "<value>"
    },
    "name": "set_inventory_item_custom_field"
  }
}

Input Schema

NameRequiredDescriptionDefault
valueYes
fieldNameYes
showInTableNo
inventoryItemIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

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

With no annotations provided, the description carries the full burden and does well: it discloses the side effect that an unknown fieldName creates a new company-wide field, that showInTable is a per-field company-wide setting affecting the inventory table for every item, and that the saved field is returned. It omits permission requirements and what happens to an existing value on overwrite.

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

Conciseness4/5

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

The description is front-loaded with the core action and result, then layers the field-reuse rule and the showInTable scope note. Four tight sentences, no filler, though the showInTable explanation is slightly longer than strictly necessary.

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 a four-parameter mutation tool with no annotations, no output schema, and zero schema coverage, the description covers input meaning, side effects, and the return value adequately. The notable remaining gap is the lack of differentiation from set_inventory_item_custom_field_by_name, which an agent choosing between the two would need.

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

Parameters4/5

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

Schema description coverage is 0%, so the description must compensate, and it does: it explains the meaning of inventoryItemId, fieldName (reuse existing vs create new), value, and showInTable including its company-wide scope and default behavior. Only the expected string format of 'value' is left unstated.

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?

The description opens with a specific verb and resource ('Sets (creates or updates) a custom field value on an inventory item') and makes the upsert semantics explicit. It does not, however, distinguish itself from the very similar sibling set_inventory_item_custom_field_by_name, so an agent cannot tell the two apart from the text 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?

Usage is implied by the parameter narrative ('Provide the inventory item id, the field name...'), and the reuse-vs-create rule for fieldName is spelled out. There is no explicit guidance on when to use this versus get_inventory_item_custom_fields, list_custom_fields, remove_inventory_item_custom_field, or the by_name sibling, and no stated prerequisites.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources