Skip to content

docs(github-dev-assistant): update README to v3.0.0 with all 57 tools #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
xlabtg merged 3 commits into from
Mar 24, 2026
Merged

docs(github-dev-assistant): update README to v3.0.0 with all 57 tools #38

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
642b983
Initial commit with task details
konard Mar 24, 2026
fc5059b
docs(github-dev-assistant): update README to v3.0.0 with all 57 tools
konard Mar 24, 2026
7c6aa3e
Revert "Initial commit with task details"
konard Mar 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
256 changes: 238 additions & 18 deletions plugins/github-dev-assistant/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,32 @@
# GitHub Dev Assistant

Full GitHub development workflow automation for the [Teleton](https://github.com/xlabtg/teleton-agent) AI agent. Enables autonomous creation of repositories, files, branches, pull requests, issues, and workflow triggers — all from a Telegram chat.
Complete GitHub development workflow automation for the [Teleton](https://github.com/xlabtg/teleton-agent) AI agent. Enables autonomous management of repositories, files, branches, pull requests, issues, commits, GitHub Actions workflows, labels, user profiles, gists, notifications, security alerts, and discussions — all from a Telegram chat.

## Features

| Category | Tools |
|----------|-------|
| **Authorization** | `github_check_auth` |
| **Repositories** | `github_list_repos`, `github_create_repo` |
| **Files & Branches** | `github_get_file`, `github_update_file`, `github_create_branch` |
| **Pull Requests** | `github_create_pr`, `github_list_prs`, `github_merge_pr` |
| **Issues** | `github_create_issue`, `github_list_issues`, `github_comment_issue`, `github_close_issue` |
| **GitHub Actions** | `github_trigger_workflow` |

**14 tools total** covering the complete GitHub development lifecycle.
| **Repositories** | `github_list_repos`, `github_create_repo`, `github_fork_repo`, `github_search_repos`, `github_list_branches`, `github_push_files`, `github_get_repo_tree`, `github_list_tags`, `github_list_releases`, `github_get_latest_release` |
| **Files & Branches** | `github_get_file`, `github_update_file`, `github_create_branch`, `github_delete_file`, `github_list_directory`, `github_search_code`, `github_download_file` |
| **Pull Requests** | `github_create_pr`, `github_list_prs`, `github_merge_pr`, `github_list_comments`, `github_list_pull_request_reviews`, `github_search_issues`, `github_update_pr`, `github_add_pr_review` |
| **Issues** | `github_create_issue`, `github_list_issues`, `github_comment_issue`, `github_close_issue`, `github_update_issue`, `github_reopen_issue`, `github_assign_issue` |
| **Commits** | `github_list_commits`, `github_get_commit` |
| **GitHub Actions** | `github_trigger_workflow`, `github_list_workflows`, `github_list_workflow_runs`, `github_cancel_workflow_run`, `github_get_job_logs` |
| **Labels** | `github_list_labels`, `github_create_label`, `github_delete_label` |
| **Repo Info** | `github_list_languages`, `github_list_collaborators`, `github_list_teams` |
| **User & Social** | `github_get_me`, `github_search_users`, `github_list_notifications`, `github_star_repo`, `github_unstar_repo`, `github_list_gists`, `github_get_gist`, `github_create_gist` |
| **Security** | `github_list_code_scanning_alerts`, `github_list_dependabot_alerts` |
| **Discussions** | `github_list_discussions`, `github_get_discussion` |

**57 tools total** covering the complete GitHub development lifecycle.

## Installation

### Via Teleton Web UI
1. Open the Teleton Web UI and navigate to **Plugins**.
2. Search for `github-dev-assistant` and click **Install**.
3. Open plugin **Settings** to configure the Personal Access Token.
3. Navigate to **Keys** in the plugin settings to configure the Personal Access Token (see [Setup & Authorization](#setup--authorization) below).

### Manual Installation

Expand All @@ -38,9 +44,22 @@ cp -r plugins/github-dev-assistant ~/.teleton/plugins/
3. Select scopes: `repo`, `workflow`, `user`
4. Click **Generate token** and copy the token

### Step 2: Configure Plugin Secret
### Step 2: Configure the Token

#### Via Teleton Web UI (recommended)

1. Open the Teleton Web UI.
2. Navigate to **Plugins → GitHub Dev Assistant → Settings**.
3. Click the **Keys** tab.
4. Paste your Personal Access Token into the **`github_token`** field and save.

Set the token via environment variable or Teleton secrets store:
To update the token later, return to the same **Keys** tab, clear the existing value, paste the new token, and save.

#### Via Environment Variable

```bash
export GITHUB_DEV_ASSISTANT_GITHUB_TOKEN=ghp_your_token_here
```

| Secret | Environment Variable | Description |
|--------|---------------------|-------------|
Expand All @@ -65,6 +84,14 @@ Check my GitHub auth status
List my GitHub repos
List repos for the organization my-org, sorted by stars
Create a private GitHub repo called my-new-project with a MIT license
Fork octocat/hello-world into my account
Search GitHub for repos about machine learning in Python with over 1000 stars
List branches in my-org/my-repo
Push multiple files to my-org/my-repo on the main branch
Get the full file tree of my-org/my-repo
List all tags in my-org/my-repo
List releases for my-org/my-repo
Get the latest release of my-org/my-repo
```

### File Operations
Expand All @@ -73,6 +100,10 @@ Get the contents of README.md from octocat/hello-world
Read src/index.js from my-org/my-repo on the develop branch
Update README.md in octocat/hello with content "# Hello World" and commit message "Update docs"
Create a new file docs/api.md in my-org/my-repo with the API documentation content
Delete the file old-config.json from my-org/my-repo
List the contents of the src/ directory in my-org/my-repo
Search for "TODO" in my-org/my-repo
Download the binary release asset from my-org/my-repo
```

### Branch Operations
Expand All @@ -87,6 +118,12 @@ Create a PR in my-org/my-repo from branch feat/login-ui to main with title "Add
List open PRs in my-org/my-repo
List all PRs (open and closed) in octocat/hello
Merge PR #42 in my-org/my-repo using squash strategy
List comments on PR #42 in my-org/my-repo
List reviews on PR #42 in my-org/my-repo
Search for open PRs mentioning "authentication" in my-org/my-repo
Update PR #42 title to "Fix authentication flow"
Approve PR #42 in my-org/my-repo with comment "Looks good!"
Request changes on PR #42 in my-org/my-repo
```

### Issue Operations
Expand All @@ -95,12 +132,63 @@ Create an issue in my-org/my-repo: title "Bug: login fails on Safari", label it
List open issues in my-org/my-repo assigned to me
Comment on issue #15 in my-org/my-repo: "Fixed in PR #42"
Close issue #15 in my-org/my-repo as completed
Update the title and labels of issue #15 in my-org/my-repo
Reopen issue #15 in my-org/my-repo
Assign issue #15 in my-org/my-repo to user alice
```

### Commit Operations
```
List commits in my-org/my-repo on the main branch
Get details of commit abc1234 in my-org/my-repo including changed files
```

### GitHub Actions
```
Trigger the deploy.yml workflow on the main branch in my-org/my-repo
Run CI workflow on branch feat/new-feature in my-org/my-repo with input environment=staging
List all workflows in my-org/my-repo
List recent workflow runs for deploy.yml in my-org/my-repo
Cancel workflow run #12345 in my-org/my-repo
Get logs for job #67890 in my-org/my-repo
```

### Label Operations
```
List all labels in my-org/my-repo
Create a label "priority-high" with color #FF0000 in my-org/my-repo
Delete the label "wontfix" from my-org/my-repo
```

### Repo Info
```
List programming languages used in my-org/my-repo
List collaborators on my-org/my-repo
List teams in my-org organization
```

### User & Social
```
Get my GitHub profile info
Search GitHub for users named "alice"
List my unread GitHub notifications
Star the repo octocat/hello-world
Unstar the repo octocat/hello-world
List public gists for user alice
Get the contents of gist abc123
Create a gist with file notes.md containing "# Notes"
```

### Security
```
List code scanning alerts for my-org/my-repo
List Dependabot vulnerability alerts for my-org/my-repo
```

### Discussions
```
List discussions in my-org/my-repo
Get discussion #5 from my-org/my-repo
```

## Configuration
Expand All @@ -126,14 +214,38 @@ plugins:
## Tool Reference

### `github_check_auth`
Check whether the plugin is authenticated and return the connected user's login.
Check whether the plugin is authenticated and return the connected user's login. No parameters.

### `github_list_repos`
List repositories. Parameters: `owner`, `type`, `sort`, `direction`, `per_page`, `page`.
List repositories for a user or organization. Parameters: `owner`, `type`, `sort`, `direction`, `per_page`, `page`.

### `github_create_repo`
Create a new repository. Parameters: `name` (required), `description`, `private`, `auto_init`, `license_template`, `gitignore_template`.

### `github_fork_repo`
Fork a repository into the authenticated user's account or an organization. Parameters: `owner`, `repo` (both required), `organization`.

### `github_search_repos`
Search GitHub repositories using search qualifiers. Parameters: `query` (required), `sort`, `order`, `per_page`, `page`.

### `github_list_branches`
List branches in a repository. Parameters: `owner`, `repo` (both required), `protected`, `per_page`, `page`.

### `github_push_files`
Commit multiple files to a repository in a single operation. Parameters: `owner`, `repo`, `branch`, `message` (all required), `files` (array of `{path, content}`).

### `github_get_repo_tree`
Get the full file tree of a repository. Parameters: `owner`, `repo` (both required), `ref`, `recursive`.

### `github_list_tags`
List tags in a repository. Parameters: `owner`, `repo` (both required), `per_page`, `page`.

### `github_list_releases`
List releases for a repository. Parameters: `owner`, `repo` (both required), `per_page`, `page`.

### `github_get_latest_release`
Get the latest stable release of a repository. Parameters: `owner`, `repo` (both required).

### `github_get_file`
Read a file or list a directory. Parameters: `owner`, `repo`, `path` (all required), `ref`.

Expand All @@ -143,29 +255,137 @@ Create or update a file with a commit. Parameters: `owner`, `repo`, `path`, `con
### `github_create_branch`
Create a new branch. Parameters: `owner`, `repo`, `branch` (all required), `from_ref`.

### `github_delete_file`
Delete a file from a repository. Parameters: `owner`, `repo`, `path`, `sha`, `message` (all required), `branch`, `committer_name`, `committer_email`.

### `github_list_directory`
List contents of a directory. Parameters: `owner`, `repo`, `path` (all required), `ref`.

### `github_search_code`
Search for code patterns within a repository. Parameters: `owner`, `repo`, `query` (all required), `per_page`, `page`.

### `github_download_file`
Download a file and return its content. Parameters: `owner`, `repo`, `path` (all required), `ref`.

### `github_create_pr`
Create a pull request. Parameters: `owner`, `repo`, `title`, `head` (all required), `body`, `base`, `draft`, `maintainer_can_modify`.

### `github_list_prs`
List pull requests. Parameters: `owner`, `repo` (required), `state`, `head`, `base`, `sort`, `direction`, `per_page`, `page`.
List pull requests. Parameters: `owner`, `repo` (both required), `state`, `head`, `base`, `sort`, `direction`, `per_page`, `page`.

### `github_merge_pr`
Merge a pull request. Parameters: `owner`, `repo`, `pr_number` (all required), `merge_method`, `commit_title`, `commit_message`, `confirmed`.

### `github_list_comments`
List comments on an issue or pull request. Parameters: `owner`, `repo`, `issue_number` (all required), `per_page`, `page`.

### `github_list_pull_request_reviews`
List reviews on a pull request. Parameters: `owner`, `repo`, `pr_number` (all required), `per_page`, `page`.

### `github_search_issues`
Search for issues and pull requests across GitHub. Parameters: `query` (required), `sort`, `order`, `per_page`, `page`.

### `github_update_pr`
Update a pull request title, body, state, or base branch. Parameters: `owner`, `repo`, `pr_number` (all required), `title`, `body`, `state`, `base`.

### `github_add_pr_review`
Submit a review on a pull request (approve, request changes, or comment). Parameters: `owner`, `repo`, `pr_number`, `event` (all required), `body`, `comments`.

### `github_create_issue`
Create an issue. Parameters: `owner`, `repo`, `title` (all required), `body`, `labels`, `assignees`, `milestone`.

### `github_list_issues`
List issues. Parameters: `owner`, `repo` (required), `state`, `labels`, `assignee`, `creator`, `mentioned`, `sort`, `direction`, `per_page`, `page`.
List issues. Parameters: `owner`, `repo` (both required), `state`, `labels`, `assignee`, `creator`, `mentioned`, `sort`, `direction`, `per_page`, `page`.

### `github_comment_issue`
Add a comment. Parameters: `owner`, `repo`, `issue_number`, `body` (all required).
Add a comment to an issue or pull request. Parameters: `owner`, `repo`, `issue_number`, `body` (all required).

### `github_close_issue`
Close an issue or PR. Parameters: `owner`, `repo`, `issue_number` (all required), `comment`, `reason`.
Close an issue or pull request. Parameters: `owner`, `repo`, `issue_number` (all required), `comment`, `reason`.

### `github_update_issue`
Update the title, body, labels, or state of an existing issue. Parameters: `owner`, `repo`, `issue_number` (all required), `title`, `body`, `labels`, `state`, `assignees`.

### `github_reopen_issue`
Reopen a closed issue. Parameters: `owner`, `repo`, `issue_number` (all required).

### `github_assign_issue`
Assign an issue to one or more users. Parameters: `owner`, `repo`, `issue_number`, `assignees` (all required).

### `github_list_commits`
List commits in a repository. Parameters: `owner`, `repo` (both required), `sha`, `path`, `author`, `per_page`, `page`.

### `github_get_commit`
Get detailed information about a specific commit including changed files. Parameters: `owner`, `repo`, `ref` (all required).

### `github_trigger_workflow`
Trigger a GitHub Actions workflow dispatch. Parameters: `owner`, `repo`, `workflow_id`, `ref` (all required), `inputs`.
Manually trigger a GitHub Actions workflow dispatch. Parameters: `owner`, `repo`, `workflow_id`, `ref` (all required), `inputs`.

### `github_list_workflows`
List GitHub Actions workflows in a repository. Parameters: `owner`, `repo` (both required), `per_page`, `page`.

### `github_list_workflow_runs`
List runs of GitHub Actions workflows. Parameters: `owner`, `repo` (both required), `workflow_id`, `status`, `branch`, `per_page`, `page`.

### `github_cancel_workflow_run`
Cancel a running GitHub Actions workflow run. Parameters: `owner`, `repo`, `run_id` (all required).

### `github_get_job_logs`
Get logs and details for a specific GitHub Actions workflow job. Parameters: `owner`, `repo`, `job_id` (all required).

### `github_list_labels`
List labels in a repository. Parameters: `owner`, `repo` (both required), `per_page`, `page`.

### `github_create_label`
Create a new label in a repository. Parameters: `owner`, `repo`, `name`, `color` (all required), `description`.

### `github_delete_label`
Delete a label from a repository. Parameters: `owner`, `repo`, `name` (all required).

### `github_list_languages`
List programming languages used in a repository. Parameters: `owner`, `repo` (both required).

### `github_list_collaborators`
List collaborators on a repository. Parameters: `owner`, `repo` (both required), `affiliation`, `per_page`, `page`.

### `github_list_teams`
List teams in a GitHub organization. Parameters: `org` (required), `per_page`, `page`.

### `github_get_me`
Get the authenticated GitHub user's profile information. No parameters.

### `github_search_users`
Search for GitHub users and organizations. Parameters: `query` (required), `sort`, `order`, `per_page`, `page`.

### `github_list_notifications`
List GitHub notifications for the authenticated user. Parameters: `all`, `participating`, `per_page`, `page`.

### `github_star_repo`
Star a GitHub repository. Parameters: `owner`, `repo` (both required).

### `github_unstar_repo`
Unstar a GitHub repository. Parameters: `owner`, `repo` (both required).

### `github_list_gists`
List gists for a GitHub user. Parameters: `username`, `per_page`, `page`.

### `github_get_gist`
Get the content of a specific GitHub gist. Parameters: `gist_id` (required).

### `github_create_gist`
Create a new GitHub gist with one or more files. Parameters: `files` (required, object of `{filename: {content}}`), `description`, `public`.

### `github_list_code_scanning_alerts`
List code scanning (SAST) security alerts for a repository. Parameters: `owner`, `repo` (both required), `state`, `severity`, `per_page`, `page`.

### `github_list_dependabot_alerts`
List Dependabot vulnerability alerts for a repository. Parameters: `owner`, `repo` (both required), `state`, `severity`, `per_page`, `page`.

### `github_list_discussions`
List discussions in a GitHub repository. Parameters: `owner`, `repo` (both required), `per_page`, `page`.

### `github_get_discussion`
Get a specific GitHub discussion with its body and comments. Parameters: `owner`, `repo`, `discussion_number` (all required).

## Developer

Expand Down
Loading