malcolm_alerts

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

No annotations provided, so description must compensate. It discloses automatic filter building but does not mention side effects, permissions, rate limits, or behavior beyond parameter use.

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?

Well-structured with a concise overview followed by parameter list. Efficient and front-loaded, though the parameter list could be slightly more compact.

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?

Covers all 7 parameters with explanations. Output schema exists, so return details not needed. Lacks pagination or sorting info beyond limit, but adequate for a search tool with multiple siblings.

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?

With 0% schema description coverage, the description provides detailed parameter explanations including format hints (e.g., '1,2' for severity, 'dateparser format' for times), adding value beyond the schema.

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 states 'Search Suricata alerts with structured parameters' which is a specific verb and resource. It implies specialization but does not explicitly distinguish from siblings like malcolm_search or search_dsl.

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?

Explicitly says it builds Malcolm filters automatically and spares the user from knowing field names, guiding when to use it. Lacks when-not or explicit alternatives.

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