Commentary
Open appTry Commentary
Developer platform

Build review into your workflow.

Wire Commentary into CLIs, API clients, MCP agents, Forms result workflows, Knowledge Brain workflows, and opted-in preview apps without scraping the review UI.

Use explicit review ids, files, comments, form answers, permissions, Brain health context, evaluations, and structured output so automation can participate in human-owned review loops.

  • CLI workflows
  • HTTP API
  • MCP tools
  • Forms API
  • Brain API
Get startedView documentation

One platform. Six developer surfaces.

Pick the surface that fits the tool you are wiring into Commentary, then link deeper reference detail from docs, OpenAPI, or the MCP endpoint.

CLI

Script review loops that create drafts, fetch comments, upload revisions, and report completion from local tooling.

CLI workflow docs

API

Use OpenAPI-backed routes for comments, participants, progress, draft reviews, tokens, and web app reviews.

OpenAPI JSON

MCP

Connect agents to authenticated tools for draft reviews, comments, polls, documents, Forms, Brain reviews, and live preview review state.

MCP endpoint

Forms API and MCP

Validate form contracts, create draft review form sources, submit answers, list permitted result collections, read embedded answers, and inspect canonical git result sync.

Forms overview

Knowledge Brain API

List Brain reviews, changed files, comments, health findings, requested revisions, ready-for-review replies, and evaluation ledgers.

Brain overview

Review SDK

Instrument opted-in preview apps so UI element comments carry route, selector, and viewport context.

Review SDK overview

Forms handoff without UI scraping.

Forms APIs and MCP tools keep structured answers tied to review source, permissions, and result ownership.

Forms developer workflow

  • Create or update form sources through draft review files or Git-backed contracts, not standalone API authoring.
  • Read permitted result collections, embedded answers, raw submission values, and submitter-owned answers with explicit Forms scopes.
  • Use Forms SDK or bridge messages for custom renderers while keeping the Form Contract authoritative.
  • Inspect canonical git result files, writeback status, and explicit sync/import actions when optional git sync is configured.

Built with security in mind.

Developer access is scoped to Commentary review automation, and provider-owned content still depends on the viewer's connected provider permissions.

Current controls

  • API tokens and OAuth grants can be scoped to account, repository, branch, PR, or draft targets.
  • Fine-grained scopes separate review reads, comment reads, comment writes, and status updates.
  • OAuth access tokens are short-lived and refreshed through the consented grant.
  • Provider tokens and OAuth material are stored encrypted at rest when persistence is configured.
Agent handoff

Give agents a context packet, not a screenshot of the UI.

Automation works best when Commentary passes explicit review records and receives structured output that people can verify.

Agent

  1. Human reviewers leave comments on rendered files, plan sections, or selected UI elements.

  2. API or MCP clients read explicit review ids, files, comments, permissions, and state.

  3. Agents return structured replies, revision uploads, or status updates for people to verify.

Reviewer
Agent handoff packetExplicit, scoped, auditable
review_id
rev_123
file
launch-plan.md
comment
cmt_908 anchored to section:rollback
forms
form_456 answers scoped to sourceContext
permission
comments:write on selected review
output
reply, revision upload, form result, or resolved status

Agents should receive review ids, files, comments, permitted form answers, permissions, and allowed actions directly from Commentary instead of scraping a rendered page.

Ready to build with Commentary?

Create developer credentials, read the docs, and connect the review surface that matches your workflow.

Get startedView documentation