Skip to main content
Glama

list_sessions

Lists a pipeline's Sessions that a scoring run can judge, newest last activity first.

Instructions

Lists a pipeline's Sessions that a scoring run can judge, newest last activity first.

A Session is the turns that share a search_session_id; a run without one is a single-turn Session named by its query_id. Only Sessions whose every turn still has its trace are listed. session_id is the id a scoring run takes. To find Sessions that went wrong (a failed turn, negative feedback), use list_pipeline_traces with an OData filter instead and take each row's search_session_id, or its query_id when that is empty. :param pipeline_name: Name of the pipeline. :param origin: Only Sessions whose every turn came from a Service, the pipeline's own API, or the Playground. :param deployment_id: Only Sessions whose every turn this Service served. :param pipeline_version_id: Only Sessions whose every turn this pipeline version served. :param since: ISO-8601 time; only Sessions last active at or after it. :param until: ISO-8601 time; only Sessions last active at or before it. :param limit: Most Sessions per page (at most 200). A page can hold fewer and still have a next. :param cursor: The next value of the previous page. :returns: One page of Sessions, or an error message.

The output is automatically stored and can be referenced in other functions. Returns a formatted preview with an object ID (e.g., @obj_123). Use the object store tools in combination with the object ID to view nested properties of the object. Use the returned object ID to pass this result to other functions.

Input Schema

NameRequiredDescriptionDefault
limitNo
sinceNo
untilNo
cursorNo
originNo
deployment_idNo
pipeline_nameYes
pipeline_version_idNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.1.29

TDQS

A4.7/5.0
Behavior4/5

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

With no annotations, the description carries the burden and does well: it discloses the trace-completeness filter, the pagination quirk ('a page can hold fewer and still have a next'), and how session_id relates to what a scoring run consumes. It does not cover authorization, rate limits, or errors beyond 'or an error message', so it stops 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?

Front-loaded with purpose and the Session definition, then ordered cleanly into alternative-tool guidance, parameter docs, and return note. It is long but nearly every line carries information; the trailing object-store boilerplate is generic filler that dilutes an otherwise tight definition.

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?

For an 8-parameter list tool with no annotations and no output schema, the definition covers purpose, scope filter, all parameters, pagination, return shape, and how to handle the stored result object. Nothing an agent needs to call this correctly appears to be missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must carry all parameter meaning, and it does: every one of the 8 parameters gets a semantic gloss, including the important 'every turn' semantics for origin/deployment_id/pipeline_version_id, ISO-8601 for since/until, the 200 cap for limit, and cursor being the previous page's 'next'. The only nit is that origin values are reworded rather than matching the enum literals.

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 ('Lists a pipeline's Sessions that a scoring run can judge') plus ordering ('newest last activity first'), and defines what a Session actually is (turns sharing a search_session_id, otherwise a single-turn query_id). It explicitly distinguishes itself from the nearest sibling by naming list_pipeline_traces and the use case that selects it.

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 routing: use this for Sessions a scoring run can judge; use list_pipeline_traces with an OData filter when looking for Sessions that went wrong, and it even explains how to recover the session key from that path. The filtering constraint ('only Sessions whose every turn still has its trace') tells the agent when this tool will silently return less than expected.

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

Deploy Server

Other Tools