Skip to main content
Glama

processDefinition_getXmlById

Retrieve the BPMN 2.0 XML source of a process definition by ID to inspect or debug process models.

Instructions

Retrieve the BPMN 2.0 XML source of a process definition by ID. Useful for inspecting or debugging process models.

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_getXmlById"
  }
}

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.5/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 full behavioral burden. It does disclose the core behavior: this is a read operation that returns raw BPMN XML and does not modify anything. However, it says nothing about authorization requirements, behavior when the ID is unknown, whether suspended or deleted definitions are still readable, or the potential size of the XML payload.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short sentences, with the core action front-loaded and the secondary use case following. Nothing is padded or redundant. It could be tightened or merged, but it is close to ideal for a simple lookup tool.

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 single-parameter read tool with no output schema and no annotations, the description covers what the tool does, what it returns (BPMN 2.0 XML), and why an agent would call it. The remaining gaps, namely error behavior and permission requirements, are minor for a simple fetch, though they would be worth stating.

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 parameter 'id', so the description must carry the semantics. 'By ID' does clarify that the argument is the process definition identifier rather than a key or an instance ID, which is genuinely useful in a catalog full of *ById and *ByKey siblings. However, it adds no format detail 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 gives a specific verb and resource: it retrieves the BPMN 2.0 XML source of a process definition, and it adds the scope 'by ID'. That makes it distinguishable from processDefinition_getById, which returns the metadata rather than the XML, but it does not explicitly contrast with the close sibling processDefinition_getXmlByKey, so it is not a full 5.

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?

It provides an implied usage context: 'Useful for inspecting or debugging process models'. That tells the agent why to call it, but there is no explicit when-to-use or when-not-to-use guidance, no mention of the key-based alternative, and no note about prerequisites such as permissions or whether the definition must exist.

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