Skip to main content
Glama

ActivateServiceDefinition

Activates a named service definition, making its inactive version active. In batch mode, records the call and returns empty content; retrieve the result by number after the batch.

Instructions

Activates the service 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": "ActivateServiceDefinition"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesService definition name.
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: -"Service definition name (e.g., ZSD_MY_SERVICE)."New value: +"Service definition name."
  3. Addedv7.0.0
  4. Removedv6.11.3
  5. Addedv6.5.1

TDQS

A3.7/5.0
Behavior4/5

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

With no annotations, the description carries the burden and does add real behavioral context: it explains the activation effect on the inactive version and, unusually, the batch-mode contract (recorded under the next number, empty answer, answer retrieved by number). It omits failure behavior (does activation return check errors?) and permission requirements, which matters for a mutating operation.

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 sentences, front-loaded with the core action and effect; the batch-mode sentence is dense but every clause (recording, empty answer, retrieval by number) is operationally necessary. No filler.

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 2-parameter, no-output-schema, no-annotation mutation tool, the description covers the effect and the otherwise-invisible batch return contract, which compensates for the missing output schema. What remains uncovered is error/check behavior on activation failure.

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%, so both parameters are already documented, including the detail enum with per-value meaning. The description only echoes that the target is identified by name and says nothing about the detail parameter. Baseline 3 applies when 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 and resource ("Activates the service definition named by name") plus the effect (inactive version comes into force), which is far more specific than a tautology. It does not, however, explicitly distinguish itself from the many other Activate* siblings (ActivateServiceBinding, ActivateClass, ActivateObjects), leaving that to the 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 rather than stated: since it puts the inactive version in force, an agent can infer this is the post-edit activation step. There is no explicit when-to-use, no prerequisite mention (e.g., successful check), and no named alternative such as ActivateObjects or ActivateServiceBinding.

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