Skip to main content
Glama

ActivateBehaviorDefinition

Activates a RAP behavior definition by name, making its inactive version effective; in batch mode, records the call for later result retrieval.

Instructions

Activates the RAP behavior definition named by name, so its inactive version is in force. Recordable: in batch mode a call is recorded under the next number and answers with empty content; its answer is read by number after the batch ends.

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": {
      "name": "<name>"
    },
    "name": "ActivateBehaviorDefinition"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesBehavior definition name (root entity).
detailNoHow much of the answer to return: "terse" (default, the fields you need to act), "full" (the whole parse), "raw" (the document as ADT sent it).terse

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv20.1.0
    • removedInput schema / properties / session_id
      Removed value: -{
      -  "description": "Session ID from GetSession. If not provided, a new session will be created.",
      -  "type": "string"
      -}
    • removedInput schema / properties / session_state
      Removed value: -{
      -  "description": "Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.",
      -  "properties": {
      -    "cookie_store": {},
      -    "cookies": {
      -      "type": "string"
      -    },
      -    "csrf_token": {
      -      "type": "string"
      -    }
      -  },
      -  "type": "object"
      -}
  2. Changed2 schema fields changedv16.0.0
    • addedInput schema / properties / detail
      Added value: +{
      +  "default": "terse",
      +  "description": "How much of the answer to return: \"terse\" (default, the fields you need to act), \"full\" (the whole parse), \"raw\" (the document as ADT sent it).",
      +  "enum": [
      +    "terse",
      +    "full",
      +    "raw"
      +  ],
      +  "type": "string"
      +}
    • changedInput schema / properties / name / description
      Previous value: -"Behavior definition name (root entity, e.g., ZI_MY_ENTITY)."New value: +"Behavior definition name (root entity)."
  3. Addedv6.5.1

TDQS

A3.8/5.0
Behavior4/5

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

With no annotations, the description carries the load and does disclose real behavior: the state change (inactive version becomes active) and the non-obvious batch-mode contract where the call returns empty content and the answer must be fetched by number after the batch ends. It stops short of covering error cases, permissions, or transport implications.

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 dense sentences with the purpose front-loaded and the batch-mode caveat second; nothing is padded or redundant.

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?

A mutation tool with no annotations and no output schema, and the description still conveys the state effect and the batch-answer retrieval pattern, which is the main thing an agent could get wrong. Missing only preconditions and failure behavior, which are comparatively minor here.

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 both parameters are fully documented in the schema, including the enum values and defaults for 'detail'. The description only echoes the 'name' parameter and adds nothing about 'detail', so this is the baseline case where the schema does the work.

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 (Activates) and resource (RAP behavior definition) plus the effect ('inactive version is in force'), which is more than a restatement of the name. It doesn't explicitly differentiate itself from the numerous sibling Activate* tools (e.g. ActivateObjects, ActivateServiceDefinition), so an agent must infer the distinction from the resource name alone.

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?

Usage is implied: call it when a behavior definition has an inactive version that must be brought into force. There is no explicit statement of when not to use it or whether the generic ActivateObjects would also cover this case, and no prerequisites are named.

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