Skip to content

docs: document tool executions in the Operate area - #1129

Open
evantahler wants to merge 4 commits into
mainfrom
add-doc-screenshots
Open

docs: document tool executions in the Operate area#1129
evantahler wants to merge 4 commits into
mainfrom
add-doc-screenshots

Conversation

@evantahler

@evantahler evantahler commented Aug 15, 2026

Copy link
Copy Markdown
Contributor

Adds a Tool Executions page under Operate → Governance, next to Audit Logs, documenting the dashboard surface and read API shipped in ArcadeAI/monorepo#2661 and #2662.

The page covers both jobs the feature exists for: a developer debugging why a tool call failed by reading the exact inputs and outputs, and an operator reviewing what a project ran for compliance and usage. It documents the access split those PRs introduced — the history is readable by anyone holding a role on the project, while the recorded inputs and outputs take project-admin authority, and diagnostics stay readable either way — plus the dashboard filters, the three read endpoints, and the retention window.

Also adds three dashboard screenshots, cross-links the page from the developer-facing tool error handling guide, and adds it to the Governance and Operate card grids.

Verified with pnpm lint, pnpm test (835 pass), pnpm check-meta, Vale (0 errors), and a local dev-server render of the new page and both card grids.

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only changes with no runtime or security logic touched.

Overview
Adds Tool Executions under Operate → Governance: a new guide for the dashboard history and read API (list, count, detail with optional inputs/outputs), including filters, role-based visibility, debugging workflows, and org-level recording/retention.

Governance and Operate overview copy and card grids now mention reviewing tool runs alongside audit logs. The build tool error handling guide links to Tool Executions for post-hoc debugging. Nav metadata and public/llms.txt register the page.

Reviewed by Cursor Bugbot for commit d64aa72. Bugbot is set up for automated code reviews on this repo. Configure here.

Adds a Tool Executions page under Operate > Governance, next to Audit
Logs, covering the dashboard surface and read API shipped in
ArcadeAI/monorepo#2661 and #2662.

The page serves both jobs the feature exists for: a developer debugging
why a tool call failed by reading the exact inputs and outputs, and an
operator reviewing what a project ran for compliance and usage. It
documents the access split those PRs introduced — the history is
readable by anyone with a role on the project, while the recorded inputs
and outputs take project-admin authority, and diagnostics stay readable
either way.

Also cross-links the page from the developer-facing tool error handling
guide, and adds it to the Governance and Operate card grids.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@vercel

vercel Bot commented Aug 15, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview Aug 25, 2026 7:48pm

Request Review

@josebarrueta

Copy link
Copy Markdown
Contributor

Reviewed the Retention section against the PLT-2978 stack now in review, and opened #1141 into this branch with the corrections — stacked so nothing here is rewritten.

The headline is that "contact Arcade support" is about to stop being true: setting the retention window and turning recording on or off is becoming self-service (monorepo #3165 for the API, #3243 for the dashboard page). But three smaller things in that paragraph are worth more than the missing capability, because a reader who acts on them is misled:

  • "or a project overrides it" — project-level settings are an explicit non-goal of the spec. Nothing customer-reachable sets a project's own window, and the API reports retention_changeable_at_project: false for exactly that reason.
  • "turn off execution logging and delete the history" — these are different operations with different effects. Turning recording off stops new runs being written and leaves stored ones to expire on the window; the retention sweep marks on the window alone and never reads whether recording is on. Shortening the window is the control that deletes, and it reaches records already held.
  • No bounds — nothing said 0 and 400 are refused with a 422 rather than clamped.

One note for whoever merges: #1141 documents behaviour that hasn't shipped. If this PR lands first, hold that one until the stack merges, or the page promises a dashboard page that isn't there yet.

Everything else here reads correctly against the implementation — the filters, the authority split on inputs and outputs, and the endpoint table all match.

…2978] (#1141)

* docs(tool-executions): recording and retention are self-service

The Retention section predates PLT-2978 and told readers to contact support
for changes they can now make themselves. It was also wrong in three ways
that matter more than the missing capability:

- It offered project-level overrides. Project settings are an explicit
  non-goal; the value is organization-wide and nothing customer-reachable
  sets a project's own.
- It folded turning recording off together with deleting history. They are
  different: recording off stops new runs being written and leaves stored
  ones to expire on the window. Shortening the window is the control that
  deletes, and it reaches records already held.
- It gave no bounds, so a reader had no way to know 0 and 400 are refused.

Rewritten around the two settings, what each does to history already held,
and what a reader sees when the list is empty.

* docs(tool-executions): Evan's review — tighter, and no unshipped behaviour

Takes the suggested wording for the opening, the table, and the defaults
sentence, and types the two settings.

Drops four things: the org-admin authority line, which the opening now
covers; two connective sentences that only restated the bullets under them;
the callout about recording permitting rather than compelling, since
project-level settings do not exist and the distinction has no observable
effect until they do; and the empty-history section, which narrated UI copy
the product already shows.

The Callout import goes with its last use.

* docs(tool-executions): scope the defaults to Arcade Cloud

"By default, recording is enabled" holds for Arcade Cloud, where the
organization starts at ALLOWED and projects start enabled. It does not hold
for a self-hosted deployment: the Engine's execution_logging.enabled
defaults to false, and with it off no run is recorded and no retention
worker runs, whatever the organization's policy says.

The paragraph two below already scopes the maximum to Arcade Cloud, so this
now reads consistently, with one clause for the self-hosted case.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants