mcp-creatio

Change a system setting definition

update-sys-setting-definition

DestructiveIdempotent

Update a system setting's metadata—name, description, value type, cache/personal flags, or lookup schema—without changing its stored value.

Instructions

Change a setting's metadata (name, description, value type, cache / personal flags, lookup schema) — not its value (use set-sys-settings-value). See get-guide: sys-settings-guide.

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>",
      "definition": "<definition>"
    },
    "name": "update-sys-setting-definition"
  }
}

Input Schema

Name	Required	Description	Default
`id`	Yes	Id of the setting to change.
`definition`	Yes	Changed metadata. Creatio requires `code`, `name` and `valueTypeName` on every update — send the current values for those you do not change.

Schema Changelog

Changes observed during successful MCP inspections.

Changed8 schema fields changedv0.8.0Oct 25, 2026

changedInput schema / properties / definition / description

Previous value: -"Creatio requires Code, Name, and valueTypeName on every UpdateSysSettingRequest. Always include those fields (existing values are OK) plus any other properties that need updating."New value: +"Changed metadata. Creatio requires `code`, `name` and `valueTypeName` on every update — send the current values for those you do not change."

changedInput schema / properties / definition / properties / code / description

Previous value: -"Unique system setting code (e.g., \"TestSetting\"). Must follow Creatio naming rules."New value: +"Unique setting code (e.g. \"UsrMaxRetries\")."

removedInput schema / properties / definition / properties / dataValueType / anyOf

Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "number"
-  }
-]

addedInput schema / properties / definition / properties / dataValueType / type
```
Added value: +[
+  "string",
+  "number"
+]
```

changedInput schema / properties / definition / properties / name / description

Previous value: -"Display name rendered in Creatio UI (e.g., \"Test setting\")."New value: +"Name shown in the Creatio UI."

changedInput schema / properties / definition / properties / referenceSchemaUId / description

Previous value: -"EntitySchema UId for lookup system settings. Required only when valueTypeName=\"Lookup\". See /sys-settings-guide prompt for the recommended VwWorkspaceObjects query to retrieve this UId."New value: +"Entity schema UId the lookup points to; required only when valueTypeName is \"Lookup\" (how to find it: get-guide: sys-settings-guide)."

changedInput schema / properties / definition / properties / valueTypeName / description

Previous value: -"Creatio data value type name. See /sys-settings-guide prompt for the table of supported valueTypeName values (Binary, Boolean, DateTime, etc.) and always send the raw value string."New value: +"Value type name (Text, Boolean, Integer, Lookup, DateTime, …) — the full list is in get-guide: sys-settings-guide."

changedInput schema / properties / id / description

Previous value: -"Existing SysSetting Id (Guid) to update."New value: +"Id of the setting to change."

First observedv0.6.5Jun 28, 2026

TDQS

A4/5.0

Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare destructiveHint=true and idempotentHint=true, so safety is covered structurally; the description adds that the scope is metadata only. It does not, however, disclose what the destructive aspect means in practice (e.g. that omitting code/name/valueTypeName or changing a code affects dependent settings).

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?

A single front-loaded sentence: the positive scope comes first, the exclusion and alternative second, and a guide pointer last. No repeated or padding content.

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 nested-object mutation tool with no output schema, the description plus the fully documented schema and the get-guide pointer give enough to invoke it correctly. The only gap is any note about code changes affecting existing references, which is arguably not essential to a correct call.

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 100% and the nested `definition` object documents every field, so the baseline is 3. The description's field list mirrors what the schema already says rather than adding syntax, format, or defaulting semantics.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb+resource ('Change a setting's metadata') and enumerates the exact metadata fields affected (name, description, value type, cache/personal flags, lookup schema). It also explicitly distinguishes itself from the value-mutating sibling, so an agent can classify it without opening the schema.

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

Usage Guidelines4/5

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

Names the alternative ('use set-sys-settings-value') and the condition that selects it (changing the value vs. the metadata), which is the main routing decision for this tool. It stops short of stating prerequisites or the requirement to resend unchanged fields, but that latter guidance is carried by the schema.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.