Skip to main content
Glama
MCP Dokploy Online
by igoruam

previewDeployment-one

Read-onlyIdempotent

Retrieve details for a single preview deployment using its ID. Use this to inspect one preview environment's configuration, status, and related metadata before deploying or troubleshooting.

Instructions

GET /previewDeployment.one

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": {
      "previewDeploymentId": "<previewDeploymentId>"
    },
    "name": "previewDeployment-one"
  }
}

Input Schema

NameRequiredDescriptionDefault
previewDeploymentIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

D1.8/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 known without the description. The description adds nothing beyond that — no note on what identifies a preview deployment, whether a missing ID errors, or what the openWorld lookup implies.

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 short, but shortness here is under-specification rather than conciseness: the entire body is an endpoint path with no front-loaded statement of intent an agent could act on.

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?

For a single-lookup tool with one undocumented required parameter and no output schema, the description should at least say it fetches one preview deployment and what the identifier refers to. Neither is present, leaving the agent to infer everything from the name.

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

Parameters2/5

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

The single required parameter previewDeploymentId has 0% schema description coverage, so the schema supplies only a type and the description supplies nothing. There is no indication of ID format, source, or behavior when the value does not resolve.

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 a raw HTTP path fragment, 'GET /previewDeployment.one', which only implies a read of a single preview deployment by contrast with the '-all' sibling. It never states a verb like 'retrieve' or what the call actually returns, so purpose is inferred rather than declared.

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 any alternative such as previewDeployment-all or previewDeployment-redeploy. The only hint is the '-one' suffix in the tool name, which the description does not explain.

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