Skip to main content
Glama
MCP Dokploy Online
by igoruam

deployment-readLogs

Read-onlyIdempotent

Retrieve and review logs for a specific deployment by ID, with an optional tail limit, to troubleshoot build or runtime issues.

Instructions

GET /deployment.readLogs

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": {
      "deploymentId": "<deploymentId>"
    },
    "name": "deployment-readLogs"
  }
}

Input Schema

NameRequiredDescriptionDefault
tailNo
deploymentIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

D1.6/5.0
Behavior2/5

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

Annotations already declare readOnlyHint, idempotentHint, and openWorldHint, so the safety profile is covered. The description adds nothing beyond the HTTP verb, leaving undisclosed how much log data is returned, whether output is truncated, or what the `tail` default of 100 implies for callers.

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?

The single line is terse but not concise in a useful sense: it is under-specified rather than economical. Every meaningful detail an agent needs was omitted, so brevity here is a defect rather than a virtue.

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?

With 0% schema coverage, no output schema, and no annotations explaining return shape, the description was the only place to convey log semantics and tail behavior, and it conveys none of it. For a log-retrieval tool this leaves an agent unable to call it correctly or anticipate output volume.

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?

Schema description coverage is 0% for two parameters. `deploymentId` is inferable from its name and minLength, but `tail` (integer, default 100, max 10000) is completely undefined — the description never explains that it limits the number of returned log lines, which is the single most important calling detail.

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 "GET /deployment.readLogs", which essentially restates the tool name and title with an HTTP method attached. It does not state in plain language that it retrieves log output for a deployment, nor distinguish it from the many sibling readLogs tools (application-, compose-, postgres-, etc.).

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 mention of alternatives such as ai-analyzeLogs or application-readLogs. An agent has no basis for choosing this tool over the sibling log readers beyond the name.

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