GitHub Tools Documentation

This document lists all available GitHub tools and their usage.

Tools

Tool Name	Description	Parameters
github_get_issue	Get details of a specific issue or pull request in a GitHub repository.	- owner (string): The owner of the repository - repo (string): The name of the repository - issue_number (string): The number of the issue or pull request
github_create_issue	Create a new issue in a GitHub repository.	- owner (string): The owner of the repository - repo (string): The name of the repository - title (string): The title of the issue - body (string, optional): The content of the issue - labels (string[], optional): Labels to apply to the issue

Configuration

Our Github integration supports Personal Access Token based authentication. Below are instructions for setting up the two most common PAT token types:

• Create a Classic PAT
• Create a Fine Grained PAT (Recommended)

Create a Classic PAT

1. Go to GitHub Settings:
2. Click your profile picture in the top right
3. Select "Settings"
4. Click "Developer settings" at the bottom of the left sidebar

5. Click "Personal access tokens" → "Tokens (classic)"

6. Generate a new token:

7. Click "Generate new token" → "Generate new token (classic)"
8. Give your token a descriptive name in the "Note" field

9. Set an expiration date (recommended for security)

10. Select the required scopes:

11. For basic repository access: repo scope
12. For private repositories: ensure repo is selected

13. For public repositories only: public_repo scope

14. Click "Generate token" and copy the token immediately (you won't be able to see it again)

Create a Fine Grained PAT (Recommended)

1. Go to GitHub Settings:
2. Click your profile picture in the top right
3. Select "Settings"
4. Click "Developer settings" at the bottom of the left sidebar

5. Click "Personal access tokens" → "Fine grained tokens"

6. Generate a new token:

7. Click "Generate new token" → "Generate new token"
8. Give your token a name - Ideally separate datamates_name
9. Set an expiration date (recommended for security)
10. Select the repositories
11. Select the following permissions -

Issues - read and write Metadata permissions are automatically granted read access by enabling any other permission

Organization owners can restrict the access of personal access token (classic) to their organization. If you try to use a personal access token which has been access controled at your account level, your request will fail with a 4xx response.