Skip to main content

GitHub Actions

Connects to the GitHub REST API for a specific repository to manage CI/CD workflows. An agent can trigger workflow dispatches, list and inspect runs, list workflows, cancel runs, and view job/step results.

Add to an agent node's tools array with _node_type: "tool-github-actions". See Connector Reference — How connectors are used.

Authentication

FieldRequiredDescription
tokenYesGitHub Personal Access Token with repo and actions scope, sent as Authorization: Bearer <token>.
ownerNoRepository owner (user or organization), used to build the API base URL.
repoNoRepository name, used to build the API base URL.
{
"name": "github_actions",
"_node_type": "tool-github-actions",
"token": "{{ secret.GITHUB_TOKEN }}",
"owner": "my-org",
"repo": "my-repo"
}

Tools

github_actions_trigger

Trigger a GitHub Actions workflow dispatch event to start a workflow run.

Parameters

ParameterTypeRequiredDescription
workflowstringYesWorkflow file name e.g. deploy.yml or workflow ID
refstringNoBranch or tag to run on (default: main)
inputsobjectNoWorkflow dispatch inputs as key-value pairs

Returns: A confirmation message that the workflow was triggered, suggesting use of github_actions_list_runs to check status.

github_actions_list_runs

List recent GitHub Actions workflow runs with their status and conclusion.

Parameters

ParameterTypeRequiredDescription
workflowstringNoFilter by workflow file name
statusstringNoFilter: completed, action_required, in_progress, queued, requested, waiting
limitnumberNoMax runs (default 10)

Returns: A newline-separated list of [<id>] <status> <conclusion> <name> <head_branch> lines.

github_actions_get_run

Get detailed info about a specific GitHub Actions workflow run.

Parameters

ParameterTypeRequiredDescription
run_idnumberYesWorkflow run ID

Returns: A multi-line summary with the run ID, status, conclusion, branch, commit SHA, and HTML URL.

github_actions_list_workflows

List all GitHub Actions workflows defined in the repository.

No parameters.

Returns: A newline-separated list of [<id>] <name> state=<state> lines.

github_actions_cancel

Cancel a running GitHub Actions workflow run.

Parameters

ParameterTypeRequiredDescription
run_idnumberYesRun ID to cancel

Returns: A confirmation message: Run <run_id> cancelled..

github_actions_list_jobs

List jobs and their step results for a GitHub Actions run.

Parameters

ParameterTypeRequiredDescription
run_idnumberYesRun ID to get jobs for

Returns: For each job, a line Job: <name> <status> <conclusion> followed by an indented Step: <name> <conclusion> line for each step.

Next