Skip to content

submit_pull_request_review

Submit an explicit comment, approval, or change request on an identified pull request. Do not use this for financial-model audits, model logic review, or general review context; use get_model_review_context for that. Requires at least Editor role. event options: ‘comment’ (neutral feedback), ‘approve’ (signal ready to merge), ‘request_changes’ (block merge until addressed).

NameTypeRequiredDefaultDescription
model_nameAnnotated[str, Field(description='Name of the Bridge Town model.')]Yes
pull_request_idAnnotated[int, Field(description='Numeric ID of the pull request within the model.')]Yes
eventAnnotated[Literal['comment', 'approve', 'request_changes'], Field(description="Review decision: 'comment' (leave a comment), 'approve' (approve the PR), or 'request_changes' (request changes).")]Yes
bodyAnnotated[str, Field(description="Review comment text. Required when event is 'COMMENT' or 'REQUEST_CHANGES'.")]No''
workspace_id`Annotated[strNone, Field(description=WORKSPACE_ID_FIELD_DESCRIPTION)]`NoNone

Returns a structured object. Top-level fields:

  • model (string)
  • pull_request_id (integer)
  • event (string)
  • message (string)

See the response example below for the full payload shape.

{
"name": "submit_pull_request_review",
"arguments": {
"model_name": "forecasts",
"pull_request_id": 42,
"event": "approve",
"body": "Numbers look right. LGTM."
}
}
{
"model": "forecasts",
"pull_request_id": 42,
"event": "approve",
"message": "Review submitted."
}
  • Module: Pull Requests
  • Requires authentication via API token or Auth0 JWT.