GitHub
Interact with GitHub or trigger workflows from GitHub events
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, 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. Trigger workflows from GitHub events like push, pull requests, and issues.
Tools
github_pr
Fetch PR details including diff and files changed
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
owner | string | Yes | Repository owner |
repo | string | Yes | Repository name |
pullNumber | number | Yes | Pull request number |
apiKey | string | Yes | GitHub API token |
Output
| Parameter | Type | Description |
|---|---|---|
content | string | Human-readable PR summary |
metadata | object | Detailed PR metadata including file changes |
github_comment
Create comments on GitHub PRs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
owner | string | Yes | Repository owner |
repo | string | Yes | Repository name |
body | string | Yes | Comment content |
pullNumber | number | Yes | Pull request number |
path | string | No | File path for review comment |
position | number | No | Line number for review comment |
commentType | string | No | Type of comment (pr_comment or file_comment) |
line | number | No | Line number for review comment |
side | string | No | Side of the diff (LEFT or RIGHT) |
commitId | string | No | The SHA of the commit to comment on |
apiKey | string | Yes | GitHub API token |
Output
| Parameter | Type | Description |
|---|---|---|
content | string | Human-readable comment confirmation |
metadata | object | Comment metadata |
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
| Parameter | Type | Required | Description |
|---|---|---|---|
owner | string | Yes | Repository owner (user or organization) |
repo | string | Yes | Repository name |
apiKey | string | Yes | GitHub Personal Access Token |
Output
| Parameter | Type | Description |
|---|---|---|
content | string | Human-readable repository summary |
metadata | object | Repository metadata |
github_latest_commit
Retrieve the latest commit from a GitHub repository
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
owner | string | Yes | Repository owner (user or organization) |
repo | string | Yes | Repository name |
branch | string | No | Branch name (defaults to the repository's default branch) |
apiKey | string | Yes | GitHub API token |
Output
| Parameter | Type | Description |
|---|---|---|
content | string | Human-readable commit summary |
metadata | object | Commit metadata |
Notes
- Category:
tools - Type:
github