arkime_sessions

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

No annotations are provided, so the description carries full burden. It describes a read-like operation (search) and includes parameter constraints (limit 1-100, time range semantics), but does not explicitly confirm it is read-only or discuss side effects, authentication, or rate limits. The implied behavior is adequate but not fully spelled out.

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 concise and well-structured: a clear purpose line, a brief comparative note, examples, and parameter definitions. Every sentence adds value, and there is no extraneous information.

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 presence of an output schema and moderate complexity (4 params), the description covers the expression syntax, parameter details, and time range usage. It omits potential details like sorting or pagination beyond limit, but overall provides sufficient context for effective use.

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 fully compensates by explaining each parameter: expression (required), limit (range), time_from (epoch seconds and usage guidance), time_to. This adds significant meaning beyond the raw 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 clearly states the verb and resource: 'Search Arkime sessions using Arkime expression syntax.' It differentiates from siblings by specifying the query language, setting it apart from tools like search_dsl that use OpenSearch 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?

The description notes 'Arkime expressions are simpler than OpenSearch DSL,' implying use this for simpler queries, but it does not explicitly mention when not to use or contrast with other similar siblings like arkime_session_detail or arkime_unique. More explicit guidance would strengthen this dimension.

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