Skip to main content
Glama

processDefinition_deploy

Deploy BPMN or DMN process definitions to Operaton using XML content, filename, and deployment name; returns deployment metadata and deployed definition keys.

Instructions

Deploy a BPMN process definition to Operaton. Provide BPMN or DMN XML, a filename, and a deployment name. Returns deployment metadata and deployed definition keys.

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": {
      "deployment-name": "<deployment-name>",
      "bpmn-content": "<bpmn-content>"
    },
    "name": "processDefinition_deploy"
  }
}

Input Schema

NameRequiredDescriptionDefault
tenant-idNoTenant ID for multi-tenant deployments
bpmn-contentYesBPMN 2.0 XML content as a string
bpmn-filenameNoFilename for the BPMN resource (default: process.bpmn)
deployment-nameYesName for this deployment (e.g. 'loan-approval-v2')
deployment-sourceNoSource identifier for this deployment (e.g. 'git', 'manual')

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changedv1.3.0
    • addedInput schema / properties / bpmn-content
      Added value: +{
      +  "description": "BPMN 2.0 XML content as a string",
      +  "type": "string"
      +}
    • addedInput schema / properties / bpmn-filename
      Added value: +{
      +  "description": "Filename for the BPMN resource (default: process.bpmn)",
      +  "type": "string"
      +}
    • addedInput schema / properties / deployment-name
      Added value: +{
      +  "description": "Name for this deployment (e.g. 'loan-approval-v2')",
      +  "type": "string"
      +}
    • addedInput schema / properties / deployment-source
      Added value: +{
      +  "description": "Source identifier for this deployment (e.g. 'git', 'manual')",
      +  "type": "string"
      +}
    • addedInput schema / properties / tenant-id
      Added value: +{
      +  "description": "Tenant ID for multi-tenant deployments",
      +  "type": "string"
      +}
    • addedInput schema / required
      Added value: +[
      +  "deployment-name",
      +  "bpmn-content"
      +]
  2. First observedv1.1.0

TDQS

B3.2/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; it does correctly convey that this is a mutation ('Deploy') and that it returns deployment metadata and definition keys, which is useful since there is no output schema. However, it says nothing about redeploy/overwrite behavior, whether repeated deployment names create duplicate deployments, tenant scoping effects, or required permissions.

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 sentences, front-loaded with the action and followed by the required inputs and return values; nothing is padded. The only waste is the misleading 'or DMN' clause.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Covers the core invocation (what to supply) and the return shape, which suffices for a five-parameter deploy tool without an output schema. It falls short on multi-tenant behavior, deployment-source usage, and the side effects of redeploying an existing name.

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 100%, so the schema already documents all five parameters, making 3 the baseline. The description restates three of them (XML content, filename, deployment name) and omits tenant-id and deployment-source, adding no syntax or format detail beyond the schema.

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 ('Deploy a BPMN process definition to Operaton') with the target engine named, which an agent can act on directly. It is slightly weakened by the instruction to 'Provide BPMN or DMN XML', which blurs the boundary with the sibling decision_deploy that handles DMN deployments.

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

Usage Guidelines2/5

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

No guidance on when to choose this over alternatives such as decision_deploy, nor any exclusions or prerequisites. The only indirect signal is the DMN mention, which if anything pushes agents the wrong way.

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