Skip to main content
Glama

deployment_getById

Retrieve a deployment by its ID to access its name, source, deployment time, and tenant ID. Use it to inspect or verify a specific process deployment in the Operaton engine.

Instructions

Retrieve a deployment by its ID. Returns deployment name, source, time, and tenant ID.

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>"
    },
    "name": "deployment_getById"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.3.0
    • addedInput schema / properties / id
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / required
      Added value: +[
      +  "id"
      +]
  2. First observedv1.1.0

TDQS

A3.6/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the burden; "Retrieve" correctly signals a non-mutating read and it discloses the returned fields (name, source, time, tenant ID). It does not address behavior on a missing ID (error vs null), permissions, or pagination/size concerns, which for a zero-annotation tool is a real gap.

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 short sentences with the action front-loaded and the return payload second; every clause carries information and there is no filler.

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 one-parameter lookup with no output schema, the description gives both the input qualifier and the shape of the response, which is what an agent needs to call it. The only missing piece is failure behavior when the ID does not exist.

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 0% for the single `id` parameter, so the description must compensate; saying "by its ID" confirms the value is a deployment identifier rather than a key or name. It adds no format, example, or constraint details (e.g., stringified numeric ID) beyond that.

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

Purpose4/5

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

The description uses a specific verb and resource ("Retrieve a deployment") scoped by ID, which clearly separates it from deployment_list and deployment_count, and it names the fields returned. It stops short of explicitly naming the sibling it substitutes for, but the intent is unambiguous.

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

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

"By its ID" implies the tool is for when the caller already knows the deployment identifier, which is implicit usage guidance against deployment_list. However, there is no explicit when-to-use statement, no prerequisite notes, and no mention of the alternative to use when the ID is unknown.

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