Markdown compatibility2 detected · 0 enabled · mkdocs docs · 2 warnings
- HomeREADME.md
- Getting starteddocs/getting-started.md
- Core conceptsdocs/core-concepts.md
- Demo walkthroughdocs/demo-walkthrough.md
- Review pull requestsdocs/review-pull-requests.md
- Review repository branchesdocs/review-repository-branches.md
- Draft reviewsdocs/draft-reviews.md
- Brainstorming Reviewsdocs/brainstorming-reviews.md
- Live Preview Reviewsdocs/web-app-reviews.md
- Commentary Formsdocs/commentary-forms.md
- Review progressdocs/review-progress.md
- Review modesdocs/review-modes.md
- Workspacedocs/workspace.md
- Markdown renderingdocs/markdown-rendering.md
- Markdown extensionsdocs/markdown-extensions.md
- Static HTML reviewdocs/static-html-review.md
- Knowledge Braindocs/knowledge-brain.md
- Access and authenticationdocs/access-and-authentication.md
- Developer accessdocs/developer-access.md
- Generate a GitHub PATdocs/generate-a-github-pat.md
- Azure DevOpsdocs/azure-devops.md
- Commentary CLIdocs/commentary-cli.md
- Agent skillsdocs/agent-skills.md
- API and MCPdocs/api-and-mcp.md
- API referencedocs/api/reference.md
- MCP toolsCurrent page
- Blogdocs/blog.md
- Troubleshooting and FAQdocs/troubleshooting-and-faq.md
- MkDocsMkDocs is a Pro Markdown feature that is not enabled for this viewer. MkDocs-specific syntax remains visible as ordinary Markdown when compatibility rendering is unavailable.
- Repository link validationPro can validate links across this repo. Links still render with standard repository-aware rewriting.
Commentary MCP Tools
The /mcp endpoint advertises these tools through authenticated tools/list. This file is generated from the same definitions used by the route.
commentary_forms
Validate, fill, submit, list, read, and inspect source-backed Commentary Forms without UI scraping. Use action=list, list_result_collections, list_fillout_links, create_fillout_link, revoke_fillout_link, submit_fillout_link, list_fillout_results, get, validate_contract, validate_answers, create_submission, save_draft, submit, list_submissions, get_submission, export_submission, list_embedded_answers, destinations, writeback_status, git_result_sync_status, preview_result_writeback, writeback_form, writeback_submission, list_git_results, or import_git_results. Standalone form create/update is not advertised; create or update draft review files through the draft_review tool, or author Git-backed form definitions in the reviewed source. Review-scoped tokens may read and submit embedded forms only when sourceContext identifies the covered review. Raw submission values require commentary.forms.read and result-view permission; submitters can read their own submission detail. writeback_status, git_result_sync_status, and list_git_results are read-only. preview_result_writeback, writeback_form, writeback_submission, and import_git_results require commentary.forms.writeback, the forms.github_writeback license feature, and an explicit repository target. Submission writeback uses the canonical JSON git result format.
Input schema:
{ "type": "object", "properties": { "action": { "type": "string", "enum": [ "list", "list_result_collections", "list_fillout_links", "create_fillout_link", "revoke_fillout_link", "submit_fillout_link", "list_fillout_results", "get", "validate_contract", "validate_answers", "create_submission", "save_draft", "submit", "list_submissions", "get_submission", "export_submission", "list_embedded_answers", "destinations", "writeback_status", "git_result_sync_status", "preview_result_writeback", "writeback_form", "writeback_submission", "list_git_results", "import_git_results" ] }, "formId": { "type": "string" }, "linkId": { "type": "string" }, "filloutLinkId": { "type": "string" }, "token": { "type": "string" }, "shareToken": { "type": "string" }, "submissionId": { "type": "string" }, "referenceId": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "visibility": { "type": "string", "enum": [ "private", "shared", "public_placeholder" ] }, "sourceType": { "type": "string", "enum": [ "commentary", "github", "embedded", "custom" ] }, "contract": { "type": "object" }, "contractSource": { "type": "string" }, "sourceFormat": { "type": "string", "enum": [ "json", "yaml", "auto" ] }, "sourceMetadata": { "type": "object" }, "destinationConfig": { "type": "object" }, "target": { "type": "object" }, "format": { "type": "string", "enum": [ "json", "yaml", "csv" ] }, "commitMessage": { "type": "string" }, "openPullRequest": { "type": "boolean" }, "pullRequestTitle": { "type": "string" }, "pullRequestBody": { "type": "string" }, "paths": { "type": "array", "items": { "type": "string" } }, "values": { "type": "object" }, "sourceContext": { "type": "object" }, "sourceReviewHref": { "type": "string" }, "shareMode": { "type": "string", "enum": [ "specific_user", "authenticated", "anonymous" ] }, "replyMode": { "type": "string", "enum": [ "identified", "anonymous" ] }, "repeatSubmissions": { "type": "boolean" }, "recipient": { "type": "object" }, "submissionOrigin": { "type": "string", "enum": [ "api", "mcp", "cli", "agent_api" ] }, "agentAlias": { "type": "string" }, "clientName": { "type": "string" } }, "required": [ "action" ] }
draft_review
Manage Draft Review Sessions with action=create, get, list, convert_to_brainstorming, update_metadata, upload_revision, rebase, delete, list_revisions, get_revision, get_content, get_consensus_rule, update_consensus_rule, get_consensus_state, list_events, list_shares, share, revoke_share, or remove_access. Brainstorming Reviews use the same sessionId/fileId/revision APIs and require the brainstorming_reviews.agent_api feature for remote agent operations. content is the full literal UTF-8 file content. There is no path resolution, URL fetching, or server-side file loading; the client must read files and inline their contents. Use forms/.form.yaml, forms/.form.yml, or forms/*.form.json for standalone draft-backed form contracts. Draft review responses include sourceContext and formSource identifiers for actual current files; pass those through commentary_forms when reading embedded answers or submitting draft-backed forms. Create with literal content: {"action":"create","title":"Spec","files":[{"path":"docs/spec.md","content":"# Spec\n","contentType":"markdown"}]} Create a form draft: {"action":"create","title":"Intake form","files":[{"path":"forms/intake.form.yaml","content":"commentaryForm: 1\nid: intake.quick\ntitle: Intake\nschema:\n type: object\n","contentType":"auto"}]} Create empty draft: {"action":"create","title":"Spec"} Upload one changed file and omit unchanged files: {"action":"upload_revision","sessionId":"dr_123","files":[{"fileId":"file_1","content":"# Spec\nUpdated.\n"}]}
Input schema:
{ "type": "object", "properties": { "action": { "type": "string", "enum": [ "create", "get", "list", "convert_to_brainstorming", "update_metadata", "upload_revision", "rebase", "delete", "list_revisions", "get_revision", "get_content", "get_consensus_rule", "update_consensus_rule", "get_consensus_state", "list_events", "list_shares", "share", "revoke_share", "remove_access" ] }, "sessionId": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "archived" ] }, "mode": { "type": "string", "enum": [ "draft", "brainstorming" ] }, "consensusMode": { "type": "string", "enum": [ "owner_decides", "no_open_blockers", "n_of_m", "required_reviewers" ] }, "sourceType": { "type": "string", "enum": [ "api", "mcp", "cli", "agent_api" ] }, "gitBase": { "type": "object" }, "base": { "type": "object" }, "summary": { "type": "string" }, "files": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "fileId": { "type": "string" }, "content": { "type": "string" }, "contentType": { "type": "string", "enum": [ "markdown", "html", "plain_text", "auto" ] } } } }, "fileId": { "type": "string" }, "revisionId": { "type": "string" }, "revisionNumber": { "type": "number" }, "addressedThreadIds": { "type": "array", "items": { "type": "string" } }, "agentAlias": { "type": "string" }, "enabled": { "type": "boolean" }, "agreementThreshold": { "type": "number" }, "minResponseCount": { "type": "number" }, "requiredReviewerIds": { "type": "array", "items": { "type": "string" } }, "delegatedOwnerAgentParticipantId": { "type": "string" }, "requiredReviewerCondition": { "type": "string", "enum": [ "all_required_agree", "no_required_objects", "owner_plus_one_required_agrees", "threshold_no_blockers" ] }, "objectionPolicy": { "type": "string", "enum": [ "block", "owner_decision", "ignore" ] }, "blockersBlock": { "type": "boolean" }, "ownerOverrideAllowed": { "type": "boolean" }, "countOwnerAgreement": { "type": "boolean" }, "countAgentSignals": { "type": "boolean" }, "decisionPollCompletion": { "type": "string", "enum": [ "closed", "threshold" ] }, "cursor": { "type": "string" }, "limit": { "type": "number" }, "audience": { "type": "string", "enum": [ "anyone", "user" ] }, "recipient": { "type": "string" }, "shareLinkId": { "type": "string" }, "accessGrantId": { "type": "string" } }, "required": [ "action" ] }
review_comments
List, create, reply, edit where supported, resolve, reopen, signal, or summarize Commentary comments for PR, branch, and Draft Review work. Use action=list, create, reply, edit, resolve, reopen, signal, consensus_decision, or summary. For Brainstorming Reviews, signal=agree/object/blocker/needs_clarification sets one exclusive reviewer stance per actor and thread; when countAgentSignals is enabled, agentAlias must be a registered agent participant to create an independent agent stance. signal=addressed is post-update application metadata, while consensus_decision stores owner accept/reject/out-of-scope overrides. In multi-agent mode, aliased owner decisions require the configured delegatedOwnerAgentParticipantId. Create comment with agentAlias: {"action":"create","sessionId":"dr_123","fileId":"file_1","blockId":"paragraph-2","nodeType":"paragraph","sourceLineStart":3,"sourceLineEnd":3,"bodyMarkdown":"Please revise this.","agentAlias":"local-agent"} Reply with agentAlias: {"action":"reply","sessionId":"dr_123","threadId":"thread_1","bodyMarkdown":"Fixed in the latest revision.","agentAlias":"local-agent"} Resolve with a closing aliased reply: {"action":"resolve","sessionId":"dr_123","threadId":"thread_1","bodyMarkdown":"Verified.","agentAlias":"local-agent"}
Input schema:
{ "type": "object", "properties": { "action": { "type": "string", "enum": [ "list", "create", "reply", "edit", "resolve", "reopen", "signal", "summary", "consensus_decision" ] }, "provider": { "type": "string", "enum": [ "github" ] }, "owner": { "type": "string" }, "repo": { "type": "string" }, "prNumber": { "type": "number" }, "branchRef": { "type": "string" }, "sessionId": { "type": "string" }, "filePath": { "type": "string" }, "fileId": { "type": "string" }, "status": { "type": "string", "enum": [ "open", "resolved" ] }, "consensusState": { "type": "string", "enum": [ "pending", "accepted_for_change", "blocked", "needs_owner_decision", "rejected", "out_of_scope", "applied", "resolved" ] }, "threadId": { "type": "string" }, "commentId": { "type": "string" }, "blockId": { "type": "string" }, "nodeType": { "type": "string" }, "sourceLineStart": { "type": "number" }, "sourceLineEnd": { "type": "number" }, "selectedText": { "type": "string" }, "prefixText": { "type": "string" }, "suffixText": { "type": "string" }, "bodyMarkdown": { "type": "string" }, "agentAlias": { "type": "string" }, "clientName": { "type": "string" }, "signal": { "type": "string", "enum": [ "agree", "object", "blocker", "needs_clarification", "addressed" ] }, "decision": { "type": "string", "enum": [ "accepted_for_change", "rejected", "out_of_scope", "clear" ] }, "reason": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "action" ] }
web_app_review
Manage Web App Reviews for agent handoff with action=list, get, create, update_metadata, list_comments, get_agent_context, create_comment, resolve, reopen, list_shares, share, revoke_share, or remove_access. Web App Review tools require account-scoped tokens and the web_app_reviews.agent_api feature. Agent context marks comment bodies and reviewed app content as untrusted user/application content. Create comment with selected element context: {"action":"create_comment","reviewId":"rev_123","bodyMarkdown":"Make this CTA clearer.","route":"/settings","url":"http://localhost:5173/settings","origin":"http://localhost:5173","selector":"[data-commentary-id='save']","fallbackSelector":"main button:nth-of-type(1)","tagName":"button","viewport":{"width":1440,"height":900},"boundingRect":{"x":812,"y":644,"width":132,"height":40}}
Input schema:
{ "type": "object", "properties": { "action": { "type": "string", "enum": [ "list", "get", "create", "update_metadata", "list_comments", "get_agent_context", "create_comment", "resolve", "reopen", "list_shares", "share", "revoke_share", "remove_access" ] }, "reviewId": { "type": "string" }, "shareLinkId": { "type": "string" }, "accessGrantId": { "type": "string" }, "audience": { "type": "string", "enum": [ "anyone", "user" ] }, "recipient": { "type": "string" }, "title": { "type": "string" }, "sourceType": { "type": "string", "enum": [ "deployed_url", "localhost" ] }, "previewUrl": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "archived" ] }, "repo": { "type": "object" }, "externalMetadata": { "type": "object" }, "includeResolved": { "type": "boolean" }, "includeArchived": { "type": "boolean" }, "threadId": { "type": "string" }, "reviewSessionId": { "type": "string" }, "bodyMarkdown": { "type": "string" }, "body": { "type": "string" }, "route": { "type": "string" }, "url": { "type": "string" }, "origin": { "type": "string" }, "selector": { "type": "string" }, "fallbackSelector": { "type": "string" }, "tagName": { "type": "string" }, "role": { "type": "string" }, "accessibleName": { "type": "string" }, "textSnippet": { "type": "string" }, "boundingRect": { "type": "object" }, "viewport": { "type": "object" }, "component": { "type": "object" }, "commitSha": { "type": "string" } }, "required": [ "action" ] }
review_participants
List review participants, add taggable users, add an agent alias for the current user, and manage mention notifications. Use action=list, add_user, add_agent, list_notifications, or mark_notification_read. Pass provider/owner/repo with prNumber or branchRef, sessionId for Draft/Brainstorming Reviews, or webAppReviewId for Web App Reviews. Provider-backed add_user is taggable metadata only. Draft Review and deployed Web App Review add_user create a user share link as well.
Input schema:
{ "type": "object", "properties": { "action": { "type": "string", "enum": [ "list", "add_user", "add_agent", "list_notifications", "mark_notification_read" ] }, "provider": { "type": "string", "enum": [ "github" ] }, "owner": { "type": "string" }, "repo": { "type": "string" }, "prNumber": { "type": "number" }, "branchRef": { "type": "string" }, "sessionId": { "type": "string" }, "webAppReviewId": { "type": "string" }, "providerLogin": { "type": "string" }, "providerUserId": { "type": "string" }, "userId": { "type": "string" }, "agentAlias": { "type": "string" }, "displayName": { "type": "string" }, "mentionHandle": { "type": "string" }, "recipient": { "type": "string" }, "unreadOnly": { "type": "boolean" }, "notificationId": { "type": "string" } }, "required": [ "action" ] }
review_polls
List, inspect, and summarize Commentary poll comments for reviews and Brainstorming Reviews. Use action=list, get, list_actionable, list_blocked, list_needing_owner_decision, list_stale, or markdown. For Draft and Brainstorming Reviews, pass sessionId plus optional fileId, filePath, or threadId.
Input schema:
{ "type": "object", "properties": { "action": { "type": "string", "enum": [ "list", "get", "list_actionable", "list_blocked", "list_needing_owner_decision", "list_stale", "markdown" ] }, "sessionId": { "type": "string" }, "fileId": { "type": "string" }, "filePath": { "type": "string" }, "threadId": { "type": "string" }, "pollId": { "type": "string" } }, "required": [ "action" ] }
review_document
Inspect review document structure with action=list_blocks for PR/branch rendered Markdown anchors or Draft/Brainstorming Review latest-revision blocks, action=list_files for Draft/Brainstorming Review file metadata, or action=get_progress/get_file_progress/get_changed_since_reviewed/get_unreviewed_files for read-only review progress.
Input schema:
{ "type": "object", "properties": { "action": { "type": "string", "enum": [ "list_blocks", "list_files", "get_progress", "get_file_progress", "get_changed_since_reviewed", "get_unreviewed_files" ] }, "provider": { "type": "string", "enum": [ "github" ] }, "owner": { "type": "string" }, "repo": { "type": "string" }, "prNumber": { "type": "number" }, "branchRef": { "type": "string" }, "filePath": { "type": "string" }, "fileId": { "type": "string" }, "sessionId": { "type": "string" } }, "required": [ "action" ] }
brain_review
Run Knowledge Brain agent review actions: list_reviews, list_comments, list_health_findings, list_changed_files, list_requested_revisions, or mark_fix_ready.
Input schema:
{ "type": "object", "properties": { "action": { "type": "string", "enum": [ "list_reviews", "list_comments", "list_health_findings", "list_changed_files", "list_requested_revisions", "mark_fix_ready" ] }, "provider": { "type": "string", "enum": [ "github" ] }, "owner": { "type": "string" }, "repo": { "type": "string" }, "prNumber": { "type": "number" }, "branchRef": { "type": "string" }, "rootFolder": { "type": "string" }, "filePath": { "type": "string" }, "state": { "type": "string" }, "threadId": { "type": "string" }, "bodyMarkdown": { "type": "string" } }, "required": [ "action" ] }