Skip to main content
Glama

set_cluster_hosted_log_shipping

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.

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.6/5.0
Behavior5/5

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

Annotations only carry safety flags (readOnly=false, idempotent=false, destructive=false); the description adds timing (stops within ~1 minute), retention (7 days, searchable via query_logs), audit-logging of every change, the permission requirement, and a privacy warning about personal data and secrets in log lines. This is far beyond the annotation surface.

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 is front-loaded in the first clause, and the remaining sentences each carry non-redundant information (timing, retention, privacy, permissions). It is dense but slightly long, with the CLI/portal parenthetical adding mild redundancy.

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?

With no output schema, the description still covers the full calling context: prerequisites, effect and blast radius, reversal timing, retention and downstream consumer, permission scope, and audit behavior. An agent has everything needed to invoke it safely.

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 the schema already documents enabled, cluster_id and cluster_name, establishing the baseline of 3. The description adds only the emphasis that 'enabled' is required and must be explicit, which is a marginal reinforcement rather than new semantic detail.

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?

Specific verb and resource: turns shipping of a cluster's container logs to Ankra's hosted log store on or off. It names its twin read sibling (get_cluster_hosted_log_shipping) and maps to the CLI/portal equivalents, so an agent can tell it apart from the large surrounding toolset immediately.

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?

Explicit when-to-use: 'turn it on only when the user asked for it', plus a pointer to read current state via the twin getter. It also names the required permission (clusters.write), which is the practical precondition for invoking it.

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.

Resources