update_siem_config

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

With no annotations, the description discloses important behaviors: it requires org_admin role, performs a partial update, and stores the token Fernet-encrypted. These details add transparency beyond the schema, though rate limits or idempotency are not mentioned.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured: opening purpose, then provider examples, role requirement, partial update note, and explicit Args. It is concise with no redundant sentences.

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

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

Given no annotations or output schema, the description covers all essential aspects: purpose, parameters, behavior (partial update), prerequisite role, and next steps. It is complete for the tool's complexity.

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

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

The Arg section adds significant meaning beyond the input schema (which has 0% description coverage). It explains each parameter's purpose, allowed values (splunk/datadog), endpoint format, and token type, making the schema fully actionable.

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

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

The description clearly states that the tool 'Configure the SIEM push export destination for the current organisation.' It uses a specific verb ('configure') and resource ('SIEM push export destination'), and distinguishes from sibling tools like get_siem_config (read) and push_to_siem (trigger).

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

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

The description mentions that 'Only supplied fields are updated' and 'Requires org_admin role,' providing context on when to use. It also references push_to_siem as a follow-up, implying when this tool is a prerequisite. However, it does not explicitly state when not to use or contrast with get_siem_config.

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