create_pull_request

Open a merge request (pull request) from head_branch into base_branch. Use this to start a team review workflow before merging a scenario branch. Requires at least Editor role.

Parameters

Name	Type	Required	Default	Description
model_name	Annotated[str, Field(description='Name of the Bridge Town model.')]	Yes	—
title	Annotated[str, Field(description='Title for the pull request.')]	Yes	—
head_branch	Annotated[str, Field(description='Branch containing the changes to merge.')]	Yes	—
base_branch	Annotated[str, Field(description="Target branch to merge into (typically 'main').")]	No	'main'
body	Annotated[str, Field(description='Optional description or context for the pull request.')]	No	''
workspace_id	`Annotated[str	None, Field(description=WORKSPACE_ID_FIELD_DESCRIPTION)]`	No	None

Returns

Returns a structured object. Top-level fields:

• id (integer)
• title (string)
• state (string)
• head_branch (string)
• base_branch (string)
• author (string)
• created_at (string)
• updated_at (string)
• merged (boolean)

See the response example below for the full payload shape.

Example

Tool Call

{
  "name": "create_pull_request",
  "arguments": {
    "model_name": "forecasts",
    "title": "Aggressive growth scenario",
    "head_branch": "scenario/aggressive-growth",
    "base_branch": "main",
    "body": "Bumps growth_rate from 10% to 15%."
  }
}

Response

{
  "id": 42,
  "title": "Aggressive growth scenario",
  "state": "open",
  "head_branch": "scenario/aggressive-growth",
  "base_branch": "main",
  "author": "alice@example.com",
  "created_at": "2026-04-28T10:00:00+00:00",
  "updated_at": "2026-04-28T10:00:00+00:00",
  "merged": false
}

Notes

• Module: Pull Requests
• Requires authentication via API token or Auth0 JWT.