Skip to main content
Glama

Upload a text order (write)

upload_order

Uploads a text or Markdown file to create a purchase order in the mock/test tenant, or requeues an existing order when the request ID already exists.

Instructions

POST /order/upload with one text/markdown file built from the given content — for exercising the flow against the mock/test tenant. A request_id that already exists puts that order back into QUEUED and processes it again; a tenant without direct uploads answers 409. Requires AIOTIC_MCP_ALLOW_WRITES=true.

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": {
      "filename": "<filename>",
      "content": "<content>"
    },
    "name": "upload_order"
  }
}

Input Schema

NameRequiredDescriptionDefault
contentYes
filenameYes
request_idNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.1

TDQS

A3.9/5.0
Behavior4/5

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

With no annotations, the description carries the full behavioral burden and does well: it identifies a write operation, the required environment flag, the duplicate request_id re-queue behavior, and the 409 tenant limitation. It does not describe the success response, what happens to the previous order state beyond re-queueing, or any rate limits.

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 endpoint and purpose, then layered with request_id behavior, tenant error behavior, and the write-flag prerequisite. It is dense but every sentence carries operational value. Slightly tighter phrasing around the file/content relationship would improve readability.

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 three-parameter write tool with no annotations and no output schema, the description covers the essential operational context: test-tenant scope, write flag, duplicate request behavior, and a specific error case. It leaves gaps around success return values and filename/content constraints, but is otherwise sufficient to call the tool correctly.

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 0%, so the description must compensate for all three parameters. It explains that content is used to build a text/markdown file and that an existing request_id puts the order back into QUEUED for reprocessing, which adds real meaning. It does not address the filename pattern or the 20,000-character content limit, leaving those to the schema alone.

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 states a specific verb and resource: uploads a text/markdown order via POST /order/upload. It also scopes the tool to exercising the flow against the mock/test tenant, which implicitly separates it from production-facing siblings. However, it does not explicitly name or contrast with an alternative tool.

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

Usage Guidelines4/5

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

The description clearly frames usage as exercising the flow against the mock/test tenant and discloses the AIOTIC_MCP_ALLOW_WRITES=true prerequisite. It also notes a 409 response for tenants without direct uploads, giving useful context. It stops short of naming alternatives or stating explicit when-not-to-use conditions.

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