Skip to main content
Glama

Set cluster hosted log shipping

set_cluster_hosted_log_shipping
Destructive

Turn shipping of a cluster's container logs to Ankra's hosted log store on or off (the twin of ankra cluster logs-ship enable|disable and the portal's Ankra hosted logs integration). While it is on and the store is live, the cluster's agent sends the log lines of every running container to Ankra's hosted log store, where members of the organisation can search them with query_logs for 7 days; turning it off stops shipping within about a minute. Log lines can carry personal data and secrets applications print, so turn it on only when the user asked for it. 'enabled' is required and must be given explicitly. Read the current state with get_cluster_hosted_log_shipping. Every change is recorded in the organisation's audit log. Requires clusters.write.

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

Input Schema

NameRequiredDescriptionDefault
enabledYestrue sends the cluster's container logs to Ankra's hosted log store; false stops it.
cluster_idNoUUID of the target cluster. Optional when a cluster is selected.
cluster_nameNoExact name of the target cluster. Optional when a cluster is selected.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Beyond the annotations, the description explains what shipping does, how quickly disabling takes effect, the data exposure risk, the seven-day retention, audit logging, and the clusters.write permission requirement. This is substantive operational context for a destructive toggle without contradicting the supplied annotations.

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?

The core action and constraints are front-loaded, and nearly every sentence provides useful routing, safety, or behavioral detail. The parenthetical CLI and portal mapping is helpful but makes the definition longer than strictly necessary.

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

Completeness5/5

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

For a three-parameter toggle with no output schema, the description covers purpose, safety, timing, permissions, audit behavior, and the read-before-write sibling. Nothing essential for correct invocation is missing.

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

Parameters4/5

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

Schema coverage is 100%, so the schema already fully documents enabled, cluster_id, and cluster_name. The description adds that enabled is required and must be explicit, but it does not add meaning for the cluster targeting parameters beyond the schema.

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?

The description states a specific verb and resource: turning a cluster's container-log shipping to Ankra's hosted store on or off. It clearly distinguishes the tool from the read-only sibling by telling the agent to read current state with get_cluster_hosted_log_shipping.

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

Usage Guidelines5/5

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

It gives explicit when-to-use guidance: turn it on only when the user asked for it, and use get_cluster_hosted_log_shipping to read current state. It also identifies the CLI and portal equivalents and the downstream query_logs use case.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.