Skip to main content
Glama

List saved Arkime views

arkime_views
Read-only

List saved Arkime search views with their expressions to find analyst-curated queries you can run via arkime_sessions.

Instructions

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

    Use this to find the queries analysts 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: every view returned
    carries an `owner` and a `roles` list. Field meanings are in the output
    schema.
    

Input Schema

NameRequiredDescriptionDefault
limitNoMax views to return.

Output 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 declare readOnly/destructive/openWorld, but the description adds non-obvious behavior: views are per-user and per-role, so results reflect only what the configured account can see, and every view carries owner and roles. This is real context beyond the annotations, though it does not cover pagination behavior for the limit parameter.

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?

Front-loaded purpose followed by routing guidance and scoping caveat; each sentence carries weight. Slightly long due to the cluster of sibling references, but no filler.

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 correctly defers field meanings to it and instead supplies the context an agent needs: what a view is, how to use its expression, and the per-user/per-role visibility limit.

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?

Schema description coverage is 100% for the single limit parameter, so the schema already documents it. The description adds no syntax or defaulting detail beyond that, which matches the baseline 3 when structured fields do the work.

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?

States a specific verb and resource: 'List the saved search views this Arkime holds, with each one's expression.' It explicitly distinguishes itself from arkime_shortcuts (named value lists) and arkime_field_search, so an agent can tell them apart without opening schemas.

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?

Gives explicit when-to-use ('find the queries analysts already curated before writing your own'), the next step ('pass expression to arkime_sessions'), and named alternatives for adjacent needs (arkime_shortcuts, arkime_field_search, arkime_create_view). Nothing is left to inference.

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