Skip to main content
Glama

List synchronized report files

list_report_files
Read-onlyIdempotent

List report files in an active Overleaf edit session by providing the session ID. Retrieve available reports to review compilation output during synchronized editing.

Instructions

List report files in an active synchronized edit session.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
session_idYesActive sessionId returned by begin_edit_session or workflow_status

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
okYes
nextActionsYes
workflowStateYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already establish the safety profile (readOnly, idempotent, non-destructive), so the description's addition of the 'active synchronized edit session' precondition is meaningful extra context about valid call conditions. There is no contradiction with annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single sentence that front-loads the action and object, with no filler. Every word adds meaning.

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?

For a one-parameter list operation with full schema coverage, an output schema, and safety annotations, the definition is nearly complete. It could explicitly mention the behavior for an invalid or expired session, but that is inferable from 'active'.

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?

The schema provides 100% coverage, including the source format and origin of session_id, so the description need not repeat parameter details. The description adds no extra parameter semantics, but the schema already carries the burden, warranting the baseline 3.

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 identifies a specific verb ('List') and resource ('report files') and adds a distinct context ('active synchronized edit session'), which separates it from siblings like read_report_file or begin_edit_session.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It clearly frames when the tool applies — during an active synchronized edit session — implying a prerequisite such as a prior begin_edit_session call. It does not explicitly name alternatives or exclusions, so it stops short of 5.

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