Skip to main content
Glama
MCP Dokploy Online
by igoruam

ai-update

Idempotent

Updates an existing AI integration in Dokploy by ID, letting you change its name, model, API key, API URL, creation date, or enabled status.

Instructions

POST /ai.update

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": {
      "aiId": "<aiId>"
    },
    "name": "ai-update"
  }
}

Input Schema

NameRequiredDescriptionDefault
aiIdYes
nameNo
modelNo
apiKeyNo
apiUrlNo
createdAtNo
isEnabledNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

D1.3/5.0
Behavior1/5

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

Annotations already declare idempotentHint=true and openWorldHint=true, so the description's only job is to add mutation context such as which fields are patchable, partial-update semantics, or how credentials like apiKey are handled. It provides none of that — the route string contributes zero behavioral information.

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

Conciseness2/5

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

It is not verbose, but at four tokens it is under-specified rather than concise. There is no structure or front-loaded explanation of the operation to anchor the agent.

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

Completeness1/5

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

For a seven-parameter mutation tool with no output schema and only an idempotency hint in annotations, the definition supplies essentially nothing. An agent cannot determine update semantics, side effects, or return behavior from "POST /ai.update".

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

Parameters1/5

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

Seven parameters with 0% schema description coverage, and the description says nothing about any of them. Critical ambiguities — whether omitted fields are preserved or cleared, whether apiKey must be resupplied, and whether createdAt is writable — are left entirely undocumented.

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

Purpose2/5

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

The description is only the route string "POST /ai.update", which effectively restates the tool name and adds an HTTP verb. It implies updating an existing AI configuration but never states the resource or what aspect is modified, so nothing distinguishes it from siblings like ai-create or ai-get beyond the word "update".

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

Usage Guidelines1/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 this tool, when not to, or which sibling to prefer for a given intent. An agent must guess from the name alone that this is the edit path versus ai-create or ai-get.

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