Skip to main content
Glama
vp2437
by vp2437

api_put

Update existing resources by sending a PUT request to any REST API endpoint with a JSON body, query parameters, and custom headers.

Instructions

PUT request to an API endpoint

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlYesAPI URL — absolute (https://host/path) or relative to the environment baseUrl (e.g. /users)
dataYesRequest body data
paramsNoQuery parameters
headersNoCustom headers (merged on top of config + auth headers)
maxCharsNoMax characters in the returned text (0 = unlimited; defaults to config.maxResponseChars).
environmentNoEnvironment name (defaults to the active environment)
includeHeadersNoInclude sanitized response headers in the result (default: false).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.3.1

TDQS

C2.6/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. 'PUT request' faintly implies a side-effecting write operation, but the description does not mention authentication requirements, response shape, error behavior, or the impact of the request on the target resource.

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 a single, front-loaded sentence with no filler or repetition. It is appropriately short for a simple tool definition, even though it sacrifices helpful context for brevity.

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?

With seven parameters, no annotations, and no output schema, the description is far too thin to fully orient an agent. It omits return behavior, response truncation semantics, environment handling, and how this tool relates to the other api_* siblings.

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%, and the input schema clearly documents url, data, params, headers, maxChars, environment, and includeHeaders. The prose description adds no parameter-level meaning, but the schema already carries that weight, so the baseline score of 3 is appropriate.

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

Purpose3/5

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

The description states the action ('PUT request') and the target ('API endpoint'), so an agent knows the tool performs HTTP PUT calls. However, it is very generic and does not explain what PUT is used for (e.g., replacing/updating a resource), and unlike richer sibling descriptions it offers little beyond the tool name.

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?

There is no guidance on when to use api_put versus api_post, api_patch, or api_delete, nor any mention of typical update/replace scenarios. The agent must infer usage entirely from the HTTP method name and sibling tool names.

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