get_commentary

Fetch one commentary row by id, optionally with its full version history. Use this when the caller already has a commentary_id (e.g. from list_commentary) and wants the current text or the complete edit trail. Pass include_versions=true to receive the append-only history ordered oldest-first; the trail is exactly the rows persisted by prior create/update_commentary calls.

read-only · idempotent

Parameters

Name	Type	Required	Default	Description
`commentary_id`	`Annotated[str, Field(description='UUID of the commentary entry.')]`	Yes	—
`include_versions`	`Annotated[bool, Field(description='When true, include the full version history of the commentary.')]`	No	`False`

Returns

Returns a structured object. Top-level fields:

commentary (object)
versions (array<object>)

See the response example below for the full payload shape.

Example

Tool Call

{
  "name": "get_commentary",
  "arguments": {
    "commentary_id": "ffffffff-ffff-ffff-ffff-ffffffffffff",
    "include_versions": true
  }
}

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"
  },
  "versions": [
    {
      "version_id": "11111111-1111-1111-1111-111111111111",
      "commentary_id": "ffffffff-ffff-ffff-ffff-ffffffffffff",
      "tenant_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "version": 1,
      "text": "Revenue beat plan by 12% in March, mostly from SaaS expansion.",
      "author_id": "22222222-2222-2222-2222-222222222222",
      "change_note": "Initial variance readout",
      "created_at": "2026-04-28T10:00:00+00:00"
    }
  ]
}

Notes

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