Skip to main content
Glama

processInstance_start

Start a new process instance by definition key using the latest version. Optionally pass a business key and typed variables; returns the instance ID, state, and definition info.

Instructions

Start a new process instance by definition key (latest version). Accepts optional business key and typed variables. Returns instance ID, state, and definition info.

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": "processInstance_start"
  }
}

Input Schema

NameRequiredDescriptionDefault
keyYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv1.3.0
    • addedInput schema / additionalProperties
      Added value: +{}
    • addedInput schema / properties / key
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / required
      Added value: +[
      +  "key"
      +]
  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?

With no annotations, the description carries the full burden. It does disclose the return payload ('instance ID, state, and definition info') and the version-binding behavior, which is genuinely useful, but it says nothing about error behavior for an unknown key, idempotency, or whether starting is reversible/cancellable. That leaves meaningful gaps for a state-creating mutation.

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 lookup key, followed by the return shape. 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.

Completeness3/5

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

For a one-parameter tool with no annotations and no output schema, describing the return values is a real contribution. But the description advertises business keys and typed variables that the schema does not accept, leaving the agent unsure whether it can pass them, and no failure conditions are described.

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%, so the description must compensate; it clarifies that 'key' means the definition key and that the latest version is resolved, which the bare schema does not. However, it also claims the tool 'Accepts optional business key and typed variables' while the schema exposes only a single required 'key' property with additionalProperties: {}, creating a mismatch that could lead an agent to try passing parameters that are not modeled.

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 names a specific verb and resource ('Start a new process instance') and pins the lookup mode ('by definition key (latest version)'), which implicitly distinguishes it from the sibling processInstance_startById. It stops short of explicitly naming that sibling, so an agent must infer the contrast rather than read it.

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 parenthetical '(latest version)' is the only selection hint, telling the agent it will bind to the newest deployed version of the definition rather than a pinned one. There is no explicit statement of when to prefer this over processInstance_startById or what happens when multiple versions exist, so usage is implied rather than guided.

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