Skip to main content
Glama
MCP Dokploy Online
by igoruam

patch-byEntityId

Read-onlyIdempotent

Retrieve patch details for a Dokploy application or compose entity by its ID and type.

Instructions

GET /patch.byEntityId

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": {
      "id": "<id>",
      "type": "<type>"
    },
    "name": "patch-byEntityId"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYes
typeYes

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 readOnlyHint=true, idempotentHint=true and openWorldHint=true, so the description owes the agent context beyond that, and it supplies none: no mention of auth needs, upstream calls, caching, or what a miss looks like. The bare route adds zero behavioral information and does not contradict the read-only annotation.

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?

Brevity here is under-specification rather than efficiency: a single route fragment with no verb, scope, or return information. Shortness is not a virtue when nothing useful has been communicated.

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?

No output schema exists, so the description must explain return shape, and it does not. With two undocumented required parameters, an open-world read, and no annotations covering failure modes, an agent cannot call this tool with confidence.

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?

Both parameters (id and type) are required and schema description coverage is 0%, so the description carries the full burden. It explains neither what an entity id refers to nor how the application/compose enum changes behavior, leaving the agent to infer semantics from an undocumented enum.

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 "GET /patch.byEntityId", which restates the tool name rather than explaining what the tool does. An agent learns only that some patch resource is fetched by entity id; it does not learn what a patch is here, what entity types mean, or what comes back.

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 when-to-use guidance, no prerequisites, and no routing to alternatives such as patch-one or patch-cleanPatchRepos. The agent must guess from the name alone whether this is the right lookup for a given entity.

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