Skip to main content
Glama

Update outbox fax

update-outbox-fax
Destructive

Update a queued outbox fax (comment only).

Side effects: modifies outbox record metadata.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
payloadYesOutbox update payload.
user_idNoFax.Plus user ID. Default: self.
outbox_fax_idYesOutbox fax ID to update.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
updatedYes
user_idYes
outbox_fax_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already mark destructiveHint=true; the description adds the specific side effect that it modifies outbox record metadata, clarifying that it does not send or delete the fax. No contradiction with annotations.

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?

Two short sentences with the purpose front-loaded and the side effect stated separately. Every sentence earns its place; no filler.

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 single-record metadata update, the description, complete schema, annotations, and output schema cover purpose, scope, and side effects. It lacks explicit alternative routing, but that gap is minor.

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 already documents outbox_fax_id, payload.comment, and user_id. The description's 'comment only' reinforces intent but adds no new parameter-level detail.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb ('Update') and resource ('queued outbox fax'), and scopes the operation to 'comment only'. This clearly differentiates it from related tools like update-fax or bulk-update-outbox-faxes.

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?

The description implies usage for a single queued outbox fax, and sibling names suggest bulk alternatives, but it does not explicitly state when to use this tool versus update-fax or bulk-update-outbox-faxes.

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