Skip to main content
Glama
Sign In
MCP VTEX Server

MCP VTEX Server

by leosepulveda
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

vtex_start_handling

Change order status to handling in VTEX e-commerce platform to initiate fulfillment process for a specific order ID.

Instructions

Start handling an order (change status to handling)

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": {
      "orderId": "<orderId>"
    },
    "name": "vtex_start_handling"
  }
}

Input Schema

NameRequiredDescriptionDefault
orderIdYesOrder ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

C2.9/5.0
Behavior2/5

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

With no annotations, the description carries full burden but only states the status change. It lacks details on permissions required, side effects (e.g., notifications), reversibility, or error conditions. 'Start handling' implies a mutation, but behavioral context is minimal.

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

Conciseness5/5

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

The description is a single, efficient sentence with zero waste, clearly front-loaded with the tool's purpose. Every word contributes directly to understanding the action.

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

Completeness2/5

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

For a mutation tool with no annotations and no output schema, the description is incomplete. It doesn't cover behavioral aspects like success/failure responses, idempotency, or integration with sibling tools, leaving gaps for agent decision-making.

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

Parameters3/5

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

Schema description coverage is 100%, so the schema fully documents the 'orderId' parameter. The description adds no additional meaning beyond implying it's used to identify the order for status change, aligning with the baseline for high schema coverage.

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 clearly states the action ('Start handling') and the resource ('an order'), specifying it changes the status to 'handling'. It distinguishes from siblings like 'cancel_order' or 'invoice_order' by focusing on status transition, though it doesn't explicitly contrast with them.

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

Usage Guidelines2/5

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

No guidance is provided on when to use this tool versus alternatives. It doesn't mention prerequisites (e.g., order must be in a certain state), exclusions, or related tools like 'vtex_cancel_order' or 'vtex_invoice_order' for different workflows.

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

Deploy Server

Other Tools