Skip to main content
Glama

Update API endpoint

update_api_endpoint

Patch an existing custom API endpoint. Send only the fields to change (same field set as create_api_endpoint).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlNoNew request URL.
nameNoNew internal name.
methodNoHTTP method.
endpoint_idYesId of the API endpoint to update.
tool_descriptionNoUpdated tool description.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changed
    • addedInput schema / properties / endpoint_id / description
      Added value: +"Id of the API endpoint to update."
    • addedInput schema / properties / method
      Added value: +{
      +  "description": "HTTP method.",
      +  "enum": [
      +    "GET",
      +    "POST",
      +    "PUT",
      +    "DELETE",
      +    "PATCH",
      +    "HEAD",
      +    "OPTIONS"
      +  ],
      +  "type": "string"
      +}
    • addedInput schema / properties / name
      Added value: +{
      +  "description": "New internal name.",
      +  "type": "string"
      +}
    • addedInput schema / properties / tool_description
      Added value: +{
      +  "description": "Updated tool description.",
      +  "type": "string"
      +}
    • addedInput schema / properties / url
      Added value: +{
      +  "description": "New request URL.",
      +  "type": "string"
      +}
  2. First observed

TDQS

A4/5.0
Behavior3/5

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

Annotations already show this is mutating but not destructive. The description adds the partial-update behavior ('send only the fields to change'), which is useful context. It doesn't discuss response, side effects, or permissions, but with annotations covering the safety profile this is acceptable.

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 concise sentences with no filler. The action is front-loaded and the key usage instruction follows immediately.

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 simple partial-update tool with a fully documented schema and clear annotations, the description is adequate. It covers the operation type and the update pattern; the required endpoint_id is visible in the schema, and there is no output schema to describe.

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 baseline is 3. The description adds the patch semantics and references create_api_endpoint for the field set, but doesn't need to restate individual parameter meanings since the schema already documents them.

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 action ('Patch an existing custom API endpoint') with a clear verb and resource. It distinguishes itself from create_api_endpoint by saying 'existing' and referencing the same field set, so an agent can tell update from create without opening schemas.

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?

Gives an explicit usage rule: send only the fields to change. It also points to create_api_endpoint as the reference for the field set, establishing an update-vs-create context. It doesn't explicitly name alternatives like set_endpoint_auth, but the main use case is clear.

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