Skip to main content
Glama

processDefinition_setHistoryTtlByKey

Update the history time-to-live in days for all versions of a process definition by key to control historic data retention.

Instructions

Update the history time-to-live (in days) for all versions of a process definition by key. Controls historic data retention.

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

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

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 disclose one meaningful behavioral fact — the change applies to all versions of the definition, not just the latest — which is real value beyond the schema. But it omits the consequences of the mutation (whether existing history is purged or only future retention changes) and any permission or irreversibility notes.

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, front-loaded with the action and scope; the second sentence adds a brief rationale. Efficient overall, with only mild redundancy between 'history time-to-live' and 'historic data retention.'

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 mutation tool with zero annotations, no output schema, and 0% parameter documentation, the description covers what changes and at what granularity but not the effects, constraints, or return behavior. Adequate to identify the tool, thin for calling it safely.

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 documented parameter, so the schema gives the agent nothing. The description contributes the unit for the TTL value ('in days'), which is genuinely useful, but says nothing about the key's format or the valid range/semantics of the TTL value, leaving the central input underspecified.

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: 'Update the history time-to-live (in days) for all versions of a process definition by key.' The 'by key' phrasing implicitly distinguishes it from the ById sibling, and 'all versions' clarifies the blast radius. It stops short of naming the alternative tool explicitly, which keeps it from a 5.

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 when-to-use or when-not-to-use guidance is given, and the obvious alternative (processDefinition_setHistoryTtlById) is never mentioned. Nothing tells the agent whether this affects existing historic rows, what TTL values are legal (0? negative? unlimited?), or what permissions are required.

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