Skip to main content
Glama

Search Arkime sessions

arkime_sessions
Read-only

Search Arkime sessions with an expression to obtain session IDs for drill-down into details, PCAP, payload, files, and tags.

Instructions

Search Arkime sessions by expression; returns trimmed rows each carrying a session id.

    This is the ONLY search returning a session id, and every
    session-scoped tool needs one: arkime_session_detail,
    arkime_session_pcap, arkime_session_payload,
    arkime_session_file_by_hash and arkime_add_tags. For one session's own
    row use arkime_session_detail; for its PCAP bytes/metadata use
    arkime_session_pcap. To search with Malcolm filter dicts and dateparser
    times instead of Arkime expressions and epoch seconds, use
    malcolm_search. Returns `matched` (how many sessions the expression
    found, which is usually far more than are returned), `showing`, and the
    session rows. Each row's `id` is what the drill-down tools take.
    

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMax sessions to return. Each row is a JSON object carrying its own keys, which is why this stops at 100; when you want thousands of rows and no session id, arkime_sessions_csv takes up to 10,000.
time_toNoEnd time as EPOCH SECONDS (NOT a dateparser string). Empty = now.
time_fromNoStart time as EPOCH SECONDS (NOT a dateparser string like "7 days ago"). Empty = Arkime's recent-only default; pass a range for historical data.
expressionYesArkime expression syntax (NOT OpenSearch DSL, NOT a Malcolm filter dict). Examples: "ip==192.0.2.77"; "ip.src==192.0.2.77 && ip.dst==198.51.100.1"; "protocols==dns"; "port.dst==443"; "http.uri==/login*"; "country.dst==CN". Every clause must be field-operator-value — there is no free-text search. Field existence is the literal token EXISTS!, as in "zeek.ftp.password == EXISTS!". A list is an OR: "port == [80,443]". Field names are Arkime's own, NOT the ECS names malcolm_field_search returns — look them up with arkime_field_search. A name Arkime cannot resolve is not an error: measured on Malcolm v26.07.1, "nosuch.field==1" over a window holding 6M sessions answered matched:0 with no marker, indistinguishable from a query that genuinely found nothing.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false. The description adds behavioral context beyond that: returns 'trimmed rows', includes 'matched' count that is 'usually far more than are returned', and highlights that each row's id is needed for drill-down. This enriches the agent's understanding of the return envelope and its relationship to other tools.

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 description is compact and front-loaded with the core purpose, then expands on uniqueness, alternatives, and return envelope. Each sentence adds value, though the multi-paragraph structure could be tightened slightly. It avoids redundancy and is readable.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity and the rich output schema (not shown but available), the description covers the essential context: what it returns, why it matters, and how it differs from siblings. It does not repeat return-value details already in the output schema, and it addresses when to use alternatives. Slightly more could be said about default time behavior, but that is in the parameter schema.

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 coverage is 100%: every parameter has a detailed description. The description itself adds minimal parameter-specific meaning beyond the schema, but it does clarify that 'expression' uses Arkime syntax and that the result is scoped to session ids. Baseline 3 is appropriate when the schema carries the full semantic load.

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 clearly 'Search Arkime sessions by expression; returns trimmed rows each carrying a session id.' This gives a specific verb and resource, and explicitly distinguishes it as 'the ONLY search returning a session id' compared to siblings like arkime_session_detail and arkime_sessions_csv.

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?

The description gives explicit when-to-use and alternatives: 'For one session's own row use arkime_session_detail; for its PCAP bytes/metadata use arkime_session_pcap. To search with Malcolm filter dicts and dateparser times... use malcolm_search.' It also notes arkime_sessions_csv for larger results in the schema description.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/nagameTW/mcp-server-malcolm'

If you have feedback or need assistance with the MCP directory API, please join our Discord server