Skip to main content
Glama

processDefinition_getById

Retrieve a single Operaton process definition by unique ID and return its key, version, deployment ID, resource name, and tenant for inspection or management.

Instructions

Retrieve a single process definition by its unique ID. Returns full metadata: key, version, deployment ID, resource name, and tenant.

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": "processDefinition_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?

With no annotations, the description carries the full burden; "Retrieve" conveys a read-only operation and the second sentence enumerates the returned fields, which is genuinely useful. It says nothing about behavior when the ID does not exist or about permission/tenant scoping beyond listing tenant as a returned field.

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, purpose first and returned fields second, with no filler or redundancy. Every clause carries information an agent can use.

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 simple single-parameter read tool with no output schema, the description supplies the essential return-value summary that would otherwise be missing. The only notable omission is failure behavior for an unknown ID, which is minor at this complexity.

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?

There is a single required parameter with 0% schema description coverage, so the description must compensate; it only adds the qualifier "unique," not a format, example, or source for the ID. Adequate to identify what goes in, but thin for a completely undocumented parameter.

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?

"Retrieve a single process definition by its unique ID" gives a specific verb, resource, and cardinality, which separates it from list-style siblings. It does not explicitly distinguish itself from processDefinition_getByKey or processDefinition_getXmlById, so an agent must infer the ID-vs-key split.

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?

The phrase "by its unique ID" implies the precondition that an ID (not a key) is in hand, which is the main routing decision against getByKey. However, no alternative is named and there is no statement about when not to use it, so usage is only implied.

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