Skip to main content
Glama

processDefinition_getByKey

Retrieve a process definition by key to get its current deployed version and full metadata, including version, deployment ID, and start form key.

Instructions

Retrieve the latest deployed version of a process definition by its key. Returns full metadata including version, deployment ID, and start form key.

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": {
      "key": "<key>"
    },
    "name": "processDefinition_getByKey"
  }
}

Input Schema

NameRequiredDescriptionDefault
keyYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.3.0
    • addedInput schema / properties / key
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / required
      Added value: +[
      +  "key"
      +]
  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 provided, so the description carries the full burden. It does disclose meaningful behavior beyond the name: only the LATEST deployed version is returned and the payload includes version, deployment ID, and start form key. It does not state that this is a read-only operation with no side effects, nor what happens for a nonexistent or suspended key.

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, front-loaded with the action and scope, followed by the return contents. Every clause adds information and nothing is redundant.

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 read tool with no output schema, the description covers what is returned (version, deployment ID, start form key) and the 'latest deployed' scoping. The only real gap is the meaning of 'key' relative to 'id', which the description leaves to inference.

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 coverage is 0% for the single 'key' parameter, so the description must compensate. Saying 'by its key' confirms the lookup semantics but never explains what a process definition key actually is (the BPMN process id string, not the numeric definition id), which is exactly the ambiguity created by the getById/getByKey sibling pairs.

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?

States a specific verb and resource ('Retrieve the latest deployed version of a process definition') and the lookup basis ('by its key'), which implicitly separates it from the sibling getById and from getXmlByKey. It stops short of naming those siblings explicitly, so an agent must infer the key-vs-id distinction.

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?

Usage is only implied: 'retrieve ... metadata' suggests this is the tool to use when metadata rather than the BPMN XML is wanted. There is no explicit when-to-use statement, no exclusion of getById/getXmlByKey, and no mention of behavior when the key is unknown or the definition is undeployed.

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