Docs · Connector reference

GitHub connector reference

Operations, inputs, troubleshooting, and questions for the GitHub connection. Policy decides each change before the credential is resolved, and the action record carries the result.

Set up and verify the GitHub connection

Choose one task and its account, and match the reads and actions on the overview page to it before granting provider permissions.
Prepare the connection settings from the overview page, connect the provider in Deixic, and choose which tools your agent can use.
Try a small task with a known result, and compare the returned identity and resource with what the account owner expects.
Configure approval for sensitive changes, review the destination and inputs, and check the result in the provider before expanding the workflow.

Information your agent can use

Resource	Record identity	Start with	Page coverage
Repositories	`id`	Top level	Link header
Organizations	`owner.id`	Top level	Link header
Default branch	`name`	Repositories	None configured
Classic protection	Not specified	Repositories	None configured
Branch rules	`ruleset_id` + `type`	Repositories	Link header
Rulesets	`id`	Repositories	Link header
Ruleset details	`id`	Rulesets	None configured
Pull requests	`id`	Repositories	Link header
Reviews	`id`	Pull requests	Link header
Check runs	`id`	Pull requests	Link header
Commit statuses	`id`	Pull requests	Link header
Collaborators	`id`	Repositories	Link header
Org members	`id`	Organizations	Link header
Outside collaborators	`id`	Organizations	Link header
Dependabot alerts	`number`	Repositories	Link header
Secret scanning alerts	`number`	Repositories	Link header
Organization settings	`id`	Organizations	None configured
Organization app installations	`id`	Organizations	Link header
Organization memberships	`user.id`	Org members	None configured

Record identity: Match on these fields before joining or deduplicating results; where none is specified, check the returned record first.
Start with: Resolve the parent identifier first.
Link header: Link-header pagination. The next page is identified in the response headers, rather than in the records.
None configured: No page continuation is configured for this resource. Check the response and any provider limits before treating it as a complete inventory.

Supported operations

Review the inputs before granting an action to an agent. Required inputs must be supplied, optional inputs narrow the request, and provider permissions apply in addition to Deixic policy.

Action: Can change provider state; review the target and inputs, then retain the result to avoid repeating completed work.
Read: Retrieves information; check the returned scope and identifiers before use.

Operation	Effect	Approval	Provider permissions	Inputs
Issue Create	Action	Approval required	issues.write	5
Issue Comment Create	Action	By policy	issues.write	4
Pull Request Review Comment Reply	Action	By policy	pull_requests.write	5
Repository Write	Action	Approval required	contents.write	6
Installation Repositories List	Read	By policy	contents.read	1
Pull Request Get	Read	By policy	pull_requests.read	3
Pull Request List	Read	By policy	pull_requests.read	4
Commit Check Runs List	Read	By policy	checks.read	4
Repository Compare	Read	By policy	contents.read	4
Repository Tree Get	Read	By policy	contents.read	3
Repository File Get	Read	By policy	contents.read	4
Sentinel Checks List	Read	By policy	checks.read	4
Sentinel Comments List	Read	By policy	issues.read	4
Sentinel Check Create	Action	Approval required	checks.write	7
Sentinel Comment Create	Action	Approval required	issues.write	4
Repository Snapshot Get	Read	By policy	contents.read	2
Repository Snapshot Blob Get	Read	By policy	contents.read	6
Branch Protection Get	Read	By policy	branch_protection.read	3
Branch Protection Update	Action	Approval required	branch_protection.write	11
Branch Protection Required Reviews Get	Read	By policy	branch_protection.read	4
Branch Protection Required Reviews Increase Count	Action	Approval required	branch_protection.read, branch_protection.write	6
Branch Protection Required Reviews Update	Action	Approval required	branch_protection.write	7
Repository Metadata Get	Read	By policy	branch_protection.read	2
Branch Protection Required Signatures Get	Read	By policy	branch_protection.read	4
Branch Protection Required Signatures Enable	Action	Approval required	branch_protection.read, branch_protection.write	5
Org Members List	Read	By policy	org_members.read	5
Org Member Remove	Action	Approval required	org_members.write	2
Actions Oidc Subject Get	Read	By policy	actions.read	4
Branch Protection Enforce Admins Get	Read	By policy	branch_protection.read	4
Branch Protection Enforce Admins Enable	Action	Approval required	branch_protection.read, branch_protection.write	5

Inputs by operation

Issue Create Action · approval required

Inputs for Github Issue Create
Input	Requirement	Accepted value
`body`	Optional	stringMaximum characters: 65536
`labels`	Optional	arrayMaximum items: 100
`owner`	Required	stringMinimum characters: 1Maximum characters: 100
`repository`	Required	stringMinimum characters: 1Maximum characters: 100
`title`	Required	stringMinimum characters: 1Maximum characters: 256

Issue Comment Create Action

Inputs for Github Issue Comment Create
Input	Requirement	Accepted value
`body`	Required	stringMinimum characters: 1Maximum characters: 65536
`issue_number`	Required	integerMinimum: 1Maximum: 2147483647
`owner`	Required	stringMinimum characters: 1Maximum characters: 100
`repository`	Required	stringMinimum characters: 1Maximum characters: 100

Pull Request Review Comment Reply Action

Inputs for Github Pull Request Review Comment Reply
Input	Requirement	Accepted value
`body`	Required	stringMinimum characters: 1Maximum characters: 65536
`comment_id`	Required	integerMinimum: 1Maximum: 9223372036854776000
`owner`	Required	stringMinimum characters: 1Maximum characters: 100
`pull_number`	Required	integerMinimum: 1Maximum: 2147483647
`repository`	Required	stringMinimum characters: 1Maximum characters: 100

Repository Write Action · approval required

Inputs for Github Repository Write
Input	Requirement	Accepted value
`content`	Required	stringMinimum characters: 1Maximum characters: 1048576
`message`	Required	stringMinimum characters: 1Maximum characters: 1024
`owner`	Required	stringMinimum characters: 1Maximum characters: 100
`path`	Required	stringMinimum characters: 1Maximum characters: 1024
`repository`	Required	stringMinimum characters: 1Maximum characters: 100
`sha`	Optional	string

Installation Repositories List Read

Inputs for Github Installation Repositories List
Input	Requirement	Accepted value
`page`	Required	integerMinimum: 1Maximum: 100

Pull Request Get Read

Inputs for Github Pull Request Get
Input	Requirement	Accepted value
`owner`	Required	stringMinimum characters: 1Maximum characters: 100
`pull_number`	Required	integerMinimum: 1Maximum: 2147483647
`repository`	Required	stringMinimum characters: 1Maximum characters: 100

Pull Request List Read

Inputs for Github Pull Request List
Input	Requirement	Accepted value
`owner`	Required	stringMinimum characters: 1Maximum characters: 100
`page`	Required	integerMinimum: 1Maximum: 100
`repository`	Required	stringMinimum characters: 1Maximum characters: 100
`state`	Required	string; one of: open, closed, all

Commit Check Runs List Read

Inputs for Github Commit Check Runs List
Input	Requirement	Accepted value
`head_sha`	Required	string
`owner`	Required	stringMinimum characters: 1Maximum characters: 100
`page`	Required	integerMinimum: 1Maximum: 100
`repository`	Required	stringMinimum characters: 1Maximum characters: 100

Repository Compare Read

Inputs for Github Repository Compare
Input	Requirement	Accepted value
`base_sha`	Required	string
`head_sha`	Required	string
`owner`	Required	stringMinimum characters: 1Maximum characters: 64
`repository`	Required	stringMinimum characters: 1Maximum characters: 64

Repository Tree Get Read

Inputs for Github Repository Tree Get
Input	Requirement	Accepted value
`owner`	Required	stringMinimum characters: 1Maximum characters: 64
`repository`	Required	stringMinimum characters: 1Maximum characters: 64
`revision`	Required	string

Repository File Get Read

Inputs for Github Repository File Get
Input	Requirement	Accepted value
`owner`	Required	stringMinimum characters: 1Maximum characters: 64
`path`	Required	stringMinimum characters: 1Maximum characters: 1024
`repository`	Required	stringMinimum characters: 1Maximum characters: 64
`revision`	Required	string

Sentinel Checks List Read

Inputs for Github Sentinel Checks List
Input	Requirement	Accepted value
`head_sha`	Required	string
`owner`	Required	stringMinimum characters: 1Maximum characters: 100
`page`	Required	integerMinimum: 1Maximum: 100
`repository`	Required	stringMinimum characters: 1Maximum characters: 100

Sentinel Comments List Read

Inputs for Github Sentinel Comments List
Input	Requirement	Accepted value
`owner`	Required	stringMinimum characters: 1Maximum characters: 100
`page`	Required	integerMinimum: 1Maximum: 100
`pull_number`	Required	integerMinimum: 1Maximum: 2147483647
`repository`	Required	stringMinimum characters: 1Maximum characters: 100

Sentinel Check Create Action · approval required

Inputs for Github Sentinel Check Create
Input	Requirement	Accepted value
`body`	Required	stringMinimum characters: 1Maximum characters: 52000
`conclusion`	Required	string; one of: success, neutral, action_required
`details_url`	Required	stringMinimum characters: 1Maximum characters: 2048
`head_sha`	Required	string
`marker`	Required	string
`owner`	Required	stringMinimum characters: 1Maximum characters: 100
`repository`	Required	stringMinimum characters: 1Maximum characters: 100

Sentinel Comment Create Action · approval required

Inputs for Github Sentinel Comment Create
Input	Requirement	Accepted value
`body`	Required	stringMinimum characters: 1Maximum characters: 52000
`owner`	Required	stringMinimum characters: 1Maximum characters: 100
`pull_number`	Required	integerMinimum: 1Maximum: 2147483647
`repository`	Required	stringMinimum characters: 1Maximum characters: 100

Repository Snapshot Get Read

Inputs for Github Repository Snapshot Get
Input	Requirement	Accepted value
`full_name`	Required	stringMinimum characters: 1Maximum characters: 201
`repository_id`	Required	integerMinimum: 1

Repository Snapshot Blob Get Read

Inputs for Github Repository Snapshot Blob Get
Input	Requirement	Accepted value
`commit_sha`	Required	string
`full_name`	Required	stringMinimum characters: 1Maximum characters: 201
`limit`	Required	integerMinimum: 1Maximum: 24576
`offset`	Required	integerMinimum: 0Maximum: 52428800
`path`	Required	stringMinimum characters: 1Maximum characters: 1024
`repository_id`	Required	integerMinimum: 1

Branch Protection Get Read

Inputs for Github Branch Protection Get
Input	Requirement	Accepted value
`branch`	Required	stringMinimum characters: 1Maximum characters: 255
`owner`	Required	stringMinimum characters: 1Maximum characters: 100
`repository`	Required	stringMinimum characters: 1Maximum characters: 100

Branch Protection Update Action · approval required

Inputs for Github Branch Protection Update
Input	Requirement	Accepted value
`allow_deletions`	Optional	boolean
`allow_force_pushes`	Optional	boolean
`branch`	Required	stringMinimum characters: 1Maximum characters: 255
`enforce_admins`	Required	boolean or null
`owner`	Required	stringMinimum characters: 1Maximum characters: 100
`repository`	Required	stringMinimum characters: 1Maximum characters: 100
`required_conversation_resolution`	Optional	boolean
`required_linear_history`	Optional	boolean
`required_pull_request_reviews`	Required	value
`required_status_checks`	Required	value
`restrictions`	Required	value

Branch Protection Required Reviews Get Read

Inputs for Github Branch Protection Required Reviews Get
Input	Requirement	Accepted value
`branch`	Required	stringMinimum characters: 1Maximum characters: 255
`owner`	Required	stringMinimum characters: 1Maximum characters: 100
`repository`	Required	stringMinimum characters: 1Maximum characters: 100
`repository_id`	Required	integerMinimum: 1Maximum: 9007199254740991

Branch Protection Required Reviews Increase Count Action · approval required

Inputs for Github Branch Protection Required Reviews Increase Count
Input	Requirement	Accepted value
`branch`	Required	stringMinimum characters: 1Maximum characters: 255
`expected_review_digest`	Required	string
`owner`	Required	stringMinimum characters: 1Maximum characters: 100
`repository`	Required	stringMinimum characters: 1Maximum characters: 100
`repository_id`	Required	integerMinimum: 1Maximum: 9007199254740991
`required_approving_review_count`	Required	integerMinimum: 1Maximum: 6

Branch Protection Required Reviews Update Action · approval required

Inputs for Github Branch Protection Required Reviews Update
Input	Requirement	Accepted value
`branch`	Required	stringMinimum characters: 1Maximum characters: 255
`dismiss_stale_reviews`	Optional	boolean
`owner`	Required	stringMinimum characters: 1Maximum characters: 100
`repository`	Required	stringMinimum characters: 1Maximum characters: 100
`require_code_owner_reviews`	Optional	boolean
`require_last_push_approval`	Optional	boolean
`required_approving_review_count`	Required	integerMinimum: 0Maximum: 6

Repository Metadata Get Read

Inputs for Github Repository Metadata Get
Input	Requirement	Accepted value
`full_name`	Required	stringMinimum characters: 3Maximum characters: 201
`repository_id`	Required	integerMinimum: 1Maximum: 9007199254740991

Branch Protection Required Signatures Get Read

Inputs for Github Branch Protection Required Signatures Get
Input	Requirement	Accepted value
`branch`	Required	stringMinimum characters: 1Maximum characters: 255
`owner`	Required	stringMinimum characters: 1Maximum characters: 100
`repository`	Required	stringMinimum characters: 1Maximum characters: 100
`repository_id`	Required	integerMinimum: 1Maximum: 9007199254740991

Branch Protection Required Signatures Enable Action · approval required

Inputs for Github Branch Protection Required Signatures Enable
Input	Requirement	Accepted value
`branch`	Required	stringMinimum characters: 1Maximum characters: 255
`expected_signature_digest`	Required	string
`owner`	Required	stringMinimum characters: 1Maximum characters: 100
`repository`	Required	stringMinimum characters: 1Maximum characters: 100
`repository_id`	Required	integerMinimum: 1Maximum: 9007199254740991

Org Members List Read

Inputs for Github Org Members List
Input	Requirement	Accepted value
`filter`	Optional	string; one of: all, 2fa_disabled, 2fa_insecureMinimum characters: 1Maximum characters: 16
`org`	Required	stringMinimum characters: 1Maximum characters: 100
`page`	Optional	integerMinimum: 1Maximum: 10000
`per_page`	Optional	integerMinimum: 1Maximum: 100
`role`	Optional	string; one of: all, admin, memberMinimum characters: 1Maximum characters: 16

Org Member Remove Action · approval required

Inputs for Github Org Member Remove
Input	Requirement	Accepted value
`org`	Required	stringMinimum characters: 1Maximum characters: 100
`username`	Required	stringMinimum characters: 1Maximum characters: 100

Actions Oidc Subject Get Read

Inputs for Github Actions Oidc Subject Get
Input	Requirement	Accepted value
`owner`	Required	stringMinimum characters: 1Maximum characters: 100
`owner_id`	Required	integerMinimum: 1Maximum: 9007199254740991
`repository`	Required	stringMinimum characters: 1Maximum characters: 100
`repository_id`	Required	integerMinimum: 1Maximum: 9007199254740991

Branch Protection Enforce Admins Get Read

Inputs for Github Branch Protection Enforce Admins Get
Input	Requirement	Accepted value
`branch`	Required	stringMinimum characters: 1Maximum characters: 255
`owner`	Required	stringMinimum characters: 1Maximum characters: 100
`repository`	Required	stringMinimum characters: 1Maximum characters: 100
`repository_id`	Required	integerMinimum: 1Maximum: 9007199254740991

Branch Protection Enforce Admins Enable Action · approval required

Inputs for Github Branch Protection Enforce Admins Enable
Input	Requirement	Accepted value
`branch`	Required	stringMinimum characters: 1Maximum characters: 255
`expected_admins_digest`	Required	string
`owner`	Required	stringMinimum characters: 1Maximum characters: 100
`repository`	Required	stringMinimum characters: 1Maximum characters: 100
`repository_id`	Required	integerMinimum: 1Maximum: 9007199254740991

When the GitHub task does not produce the expected result

Connected, but the expected data is missing

Check the identity behind the github app connection and its access to the specific resource; a successful connection does not establish access to every object.

Resolve parent resources first: Repositories, Rulesets, Pull requests, Organizations, Org members. A matching display name is not enough for a child lookup.

The answer covers only part of the data

Check the resource’s page coverage, query filters, and result limit, and have the agent state the account and time window it inspected, so a partial response yields a scoped answer.

The agent keeps doing the same work

Inspect the action history for repeated targets and inputs, keep the successful result’s identifiers with the task, and refresh a lookup only when the information changed.

A change is waiting or failed

Check whether the call awaits approval, was rejected by policy, lacks an input, or failed at the provider, and after a timeout inspect the destination before repeating a write.

See how an action proceeds and how to review an approval.

Questions about the GitHub connector

Can I use my existing agent with GitHub?

Yes: connect your agent to Deixic through MCP, choose which connected tools it can use, and Deixic checks calls routed through its gateway; Dex is available if your team also wants an agent.

Can an agent change data in GitHub?

This connector supports 6 actions, listed on its overview page. Configure a connection and choose the tools and provider permissions your task needs; an available action is not permission for every agent to run it, and Deixic policy and any required approval still apply to calls through the gateway.

What do I need to connect GitHub?

Prepare App ID, Installation ID, Private key; the connection uses GitHub App, and the connected identity’s provider permissions determine which resources it can access.

Does connecting GitHub keep every answer up to date?

No: an earlier answer is still an earlier answer, so for a decision that depends on current state, have the agent refresh the source and retain the lookup time, and save stable instructions separately from facts that can change.

GitHub connector overview Docs All connectors