Skip to main content
Glama

processDefinition_setHistoryTtlById

Update the history time-to-live in days for a specific process definition version by ID to control how long historic instances are retained.

Instructions

Update the history time-to-live (in days) for a specific process definition version by ID. Controls how long historic instances are retained.

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

Input Schema

NameRequiredDescriptionDefault
idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv1.3.0
    • addedInput schema / additionalProperties
      Added value: +{}
    • addedInput schema / properties / id
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / required
      Added value: +[
      +  "id"
      +]
  2. First observedv1.1.0

TDQS

C2.9/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 convey that this is a retention-setting mutation whose consequence is how long historic instances survive, which hints at data loss when the TTL is lowered, but it never says whether old history is immediately purged, whether the change is reversible, what permissions are needed, or how to reset to the default.

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 scoped by ID, with the retention consequence in the second sentence. Nothing is padded, though neither sentence resolves the ambiguity around the missing TTL argument.

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

Completeness2/5

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

A single-parameter mutation with no annotations and no output schema needs the description to cover the value being set, valid ranges or defaults, and the impact on existing history. None of that is present, and the mismatch between the described TTL input and the schema's lone 'id' property leaves the tool not callable with confidence.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 0% and the single schema property (id) is never explained beyond 'by ID'. More seriously, the description references a TTL value in days that has no corresponding parameter in the schema, leaving the agent unable to tell how the new TTL is actually supplied.

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 TTL, in days, for a process definition identified by ID. The 'ById' qualifier versus the sibling processDefinition_setHistoryTtlByKey is visible in the name, but the description never articulates that distinction itself.

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?

There is no when-to-use or when-not guidance and no mention of the ByKey alternative or when an agent should pick one over the other. The sentence 'Controls how long historic instances are retained' explains the effect, not the conditions for invoking the tool.

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