list_commentary

Discover run commentary across runs and projects accessible to the caller. All filters are AND-composed. When project_name and run_id are both omitted, the result is constrained to the caller’s accessible projects so commentary from foreign projects is never leaked. Pass include_archived=true to surface soft-deleted rows for audit/recovery flows. Returns: commentary (list) — each entry mirrors the create response; total_returned (int) — the count of rows returned.

read-only · idempotent

Parameters

Name	Type	Required	Default	Description
project_name	str	No	''
run_id	str	No	''
output_name	str	No	''
include_archived	bool	No	False

Returns

Returns a structured object. Top-level fields:

• commentary (array<object>)
• total_returned (integer)

See the response example below for the full payload shape.

Example

Tool Call

{
  "name": "list_commentary",
  "arguments": {
    "project_name": "forecasts",
    "run_id": "eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee",
    "output_name": "revenue"
  }
}

Response

{
  "commentary": [
    {
      "commentary_id": "ffffffff-ffff-ffff-ffff-ffffffffffff",
      "tenant_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "project_name": "forecasts",
      "run_id": "eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee",
      "output_name": "revenue",
      "author_id": "22222222-2222-2222-2222-222222222222",
      "text": "Revenue beat plan by 12% in March, mostly from SaaS expansion.",
      "version": 1,
      "archived_at": null,
      "archived_by": null,
      "created_at": "2026-04-28T10:00:00+00:00",
      "updated_at": "2026-04-28T10:00:00+00:00"
    }
  ],
  "total_returned": 1
}

Notes

• Module: Run Commentary
• Requires authentication via API token or Auth0 JWT.