sn_syslog

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

No annotations are provided, so the description carries the full burden. It discloses ordering ('newest first') and implies read-only via 'Query', but does not mention default limits, raw query override behavior, or any potential limitations. This is adequate but not rich.

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 a single sentence of 18 words, front-loaded with the purpose. It includes a useful behavioral detail (ordering) without any fluff, making it highly concise and well-structured.

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 the tool's simplicity and the thorough parameter schema, the description is sufficient. It does not explain return values, but none is required since there is no output schema. It omits mention of the raw query override and default limits, but these are covered in the schema descriptions, making the overall package complete enough.

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 input schema covers all 7 parameters with detailed descriptions (100% coverage), so the baseline is 3. The description's mention of 'severity, source, and time-based filters' partially maps to level, source, and since, but adds minimal value over the schema's existing documentation.

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 uses a specific verb ('Query') and clearly identifies the resource ('ServiceNow system logs (syslog table)') along with the filter dimensions (severity, source, time-based) and result ordering. This distinguishes it from generic sibling tools like sn_query or sn_get.

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 provides clear context for when to use the tool (querying the syslog table) but does not explicitly mention alternatives or exclusions. The sibling list includes sn_query, which could be ambiguous, but the specialization for syslog is evident from the resource designation.

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