Skip to main content
Glama

List saved Arkime views

arkime_views
Read-only

List saved search views and their expressions so you can reuse existing team queries in Arkime by passing an expression to arkime_sessions.

Instructions

List the saved search views this Arkime holds, with each one's expression.

    Use this to find the queries the human team already curated before
    writing your own — a view names an investigation someone thought worth
    keeping. Take a view's `expression` and pass it to arkime_sessions to
    run it. For named value lists (IOC sets) rather than saved queries, use
    arkime_shortcuts; to discover field names for a new expression, use
    arkime_field_search; to add one of your own use arkime_create_view
    (needs the arkime-view write class), and it lands in this same list.

    Views are per-user and per-role, so this shows what the configured
    account can see, not everything on the server: measured on Malcolm
    v26.07.1, every view returned carries an `owner` and a `roles` list, and
    all of them named the one account this server authenticates as. Field
    meanings are in the output schema.
    

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMax views to return.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.2.0
    • addedOutput schema / $defs / ViewList / properties / total
      Added value: +{
      +  "title": "Total",
      +  "type": "integer"
      +}
    • changedOutput schema / $defs / ViewList / required
      Previous value: -[
      -  "count",
      -  "views"
      -]New value: +[
      +  "count",
      +  "total",
      +  "views"
      +]
  2. Addedv1.0.2

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnly, non-destructive, openWorld), so the bar is lower, and the description still adds real behavior: results are per-user and per-role, so it returns only what the configured account can see, and every view carries `owner` and a `roles` list. It also notes the write class required for the sibling create path. It does not discuss pagination or ordering of the returned list, which keeps it short of a 5.

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 opening sentence front-loads what the tool returns, then usage guidance, then scope caveats — a sensible ordering with no repetition. It is somewhat longer than strictly necessary (the 'measured on Malcolm v26.07.1' framing and the re-statement of per-user/per-role scoping in two places), which keeps it from a 5.

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 an output schema present, the description need not enumerate return fields, and it correctly defers ('Field meanings are in the output schema'). For a one-parameter read-only list tool it covers purpose, routing to siblings, and the per-account scoping caveat, so nothing an agent needs to call it correctly is missing.

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?

There is a single optional `limit` parameter with 100% schema description coverage (type, default 100, min 1, max 500 all documented in the schema). The description adds nothing about the limit, so this is the baseline 3 where the schema does the heavy lifting.

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?

The description states a specific verb and resource ('List the saved search views this Arkime holds, with each one's expression') and immediately contrasts the concept with the nearest lookalike, named value lists in arkime_shortcuts. An agent can distinguish it from arkime_shortcuts, arkime_sessions, and arkime_create_view without opening any schema.

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?

It gives explicit when-to-use ('find the queries the human team already curated before writing your own') plus a concrete next step (take `expression` and pass it to arkime_sessions). It also names three alternatives with their selecting conditions: arkime_shortcuts for IOC sets, arkime_field_search for field discovery, arkime_create_view for adding one.

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