Sim Studio

GitHub

Interact with GitHub

GitHub is the world's leading platform for software development and version control using Git. It provides a collaborative environment where developers can host and review code, manage projects, and build software together.

With GitHub, you can:

  • Host repositories: Store your code in public or private repositories with version control
  • Collaborate on code: Use pull requests to propose changes, review code, and merge contributions
  • Track issues: Create, assign, and manage issues to organize work and track bugs
  • Automate workflows: Use GitHub Actions to build, test, and deploy code automatically
  • Manage projects: Organize work with project boards, milestones, and task tracking
  • Document code: Create and maintain documentation with GitHub Pages and wikis

In Sim Studio, the GitHub integration enables your agents to interact directly with GitHub repositories and workflows. This allows for powerful automation scenarios such as code review assistance, pull request management, issue tracking, and repository exploration. Your agents can fetch repository data, analyze code changes, post comments on pull requests, and perform other GitHub operations programmatically. This integration bridges the gap between your AI workflows and your development processes, enabling seamless collaboration between your agents and your development team.

Usage Instructions

Access GitHub repositories, pull requests, and comments through the GitHub API. Automate code reviews, PR management, and repository interactions within your workflow.

Tools

github_pr

Fetch PR details including diff and files changed

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
pullNumbernumberYesPull request number
apiKeystringYesGitHub API token

Output

ParameterType
metadatastring
titlestring
statestring
html_urlstring
diff_urlstring
created_atstring
updated_atstring
filesstring
additionsstring
deletionsstring
changesstring
patchstring
blob_urlstring
raw_urlstring
statusstring

github_comment

Create comments on GitHub PRs

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
pullNumbernumberYesPull request number
bodystringYesComment content
pathstringNoFile path for review comment
positionnumberNoLine number for review comment
apiKeystringYesGitHub API token
commentTypestringNoType of comment (pr_comment or file_comment)
linenumberNoLine number for review comment
sidestringNoSide of the diff (LEFT or RIGHT)
commitIdstringNoThe SHA of the commit to comment on

Output

ParameterType
metadatastring
html_urlstring
created_atstring
updated_atstring
pathstring
linestring
sidestring
commit_idstring

github_repo_info

Retrieve comprehensive GitHub repository metadata including stars, forks, issues, and primary language. Supports both public and private repositories with optional authentication.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
apiKeystringYesGitHub Personal Access Token

Output

ParameterType
metadatastring
descriptionstring
starsstring
forksstring
openIssuesstring
languagestring

github_latest_commit

Retrieve the latest commit from a GitHub repository

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
branchstringNoBranch name (defaults to the repository
apiKeystringYesGitHub API token

Output

ParameterType
metadatastring
html_urlstring
commit_messagestring
authorstring
loginstring
avatar_urlstring

Block Configuration

Input

ParameterTypeRequiredDescription
operationstringYesOperation

Outputs

OutputTypeDescription
responseobjectOutput from response
contentstringcontent of the response
metadatajsonmetadata of the response

Notes

  • Category: tools
  • Type: github
On this page

On this page