GitHub

​

Introduction

• Robust Version Control: Leveraging Git, GitHub meticulously tracks every change to your code, enabling seamless collaboration, easy rollback to previous states, and a complete history of project evolution.
• Streamlined Code Collaboration: Facilitate effective teamwork with features like pull requests for code review, in-line commenting, and branch-based development workflows, fostering a collaborative coding environment.
• Centralized Code Hosting: Provides a secure, reliable, and globally accessible platform for hosting and managing your Git repositories, ensuring code availability and integrity.
• Powerful Workflow Automation (GitHub Actions): Enables you to automate your software development lifecycle with GitHub Actions, including building, testing, and deploying code directly from your repositories.
• Issue Tracking and Project Management: Integrated issue tracking and project management tools help teams organize tasks, track bugs, and manage projects directly within the GitHub platform.

​

Toolkit’s Account Setup and Configuration in GitHub

1. Visit GitHub Website: Open your web browser and go to github.com.
2. Sign Up: Click on the “Sign up” button, located in the top right corner of the homepage.
3. Enter Details: Follow the on-screen instructions to create your account. You will need to choose a username, provide your email address, and create a strong password.
4. Verify Email: Check your inbox for a verification email from GitHub. Click the verification link in the email to activate your account.
5. Log In: Once your email is verified, log in to GitHub using your newly created username and password.

​

Generate a Personal Access Token (Classic)

1. Log in to GitHub: Access your GitHub account at github.com.
2. Access Settings: Click on your profile avatar in the top right corner and then click on “Settings”.
3. Navigate to Developer Settings: In the left-hand sidebar, scroll down and click on “Developer settings”.
4. Access Personal Access Tokens (Classic): In the left-hand sidebar under “Personal access tokens,” click on “Tokens (classic)”.
5. Generate New Token: Click the “Generate new token (classic)” button.

1. Note: Enter a descriptive label (e.g., “ELITEA Integration”) to identify this token’s purpose.
2. Expiration: Set an expiration date to limit the token’s lifespan and reduce security risk if compromised.
3. Select Scopes: Grant only the minimum necessary permissions. Overly permissive tokens pose security risks. For typical ELITEA integration, consider these minimal scopes:

• repo (For full access to private and public repositories. If possible, select more granular repo scopes instead of full repo):
  • repo:status (Access commit statuses)
  • public_repo (Access public repositories)
• workflow (Access GitHub Actions workflows if your Agent needs to interact with workflows)
• read:user (To read user profile information, often needed for basic interactions)

• issues (To access and manage issues)
• pull_request (To access and manage pull requests)
• gist (To access gists, if your Agent needs to work with gists)
• read:org (To read organization membership and information, if your Agent needs organization-level access)

4. Generate Token: Click the “Generate token” button at the bottom of the page.
5. Copy and Store Token: Copy the generated token immediately - this is your only chance to see it. Store it securely in a password manager or ELITEA’s Secrets feature. You’ll need it to configure the GitHub toolkit.

​

Authentication Using a GitHub App (Private Key)

1. Navigate to Developer Settings: Log in to your GitHub account, click your profile photo in the top-right corner, and go to Settings > Developer settings.
2. Register a New App: Select GitHub Apps from the left-hand menu and click New GitHub App.
3. Fill in App Details:
   • App Name: Enter a unique name for your application (e.g., “ELITEA Integration App”).
   • Homepage URL: Provide a valid URL. A placeholder like https://www.example.com is sufficient if you don’t have a dedicated homepage.
4. Configure Permissions: This is the most critical step. Scroll down to the “Permissions” section. For the toolkit to function correctly, you must grant the following permissions. Under Repository permissions, set the following:
   • Actions: Read & Write
   • Contents: Read & Write
   • Issues: Read & Write
   • Metadata: Read-only (This is a minimum requirement)
   • Pull requests: Read & Write
   • Projects: Read & Write
5. Set Installation Options: Under “Where can this GitHub App be installed?”, choose “Only on this account” for private use.
6. Create the App: Click Create GitHub App at the bottom of the page.

1. Generate a Private Key:
   • Scroll down to the “Private keys” section.
   • Click Generate a private key.
   • A .pem file will be immediately downloaded to your computer. This is your private key. Treat it like a password and store it securely. You will only be able to download it once.
2. Get the App ID:
   • Note the App ID displayed at the top of your GitHub App’s settings page. You’ll need this along with the private key when creating your ELITEA credential.
3. Install the App:
   • In your GitHub App’s settings, click the Install App tab in the left sidebar.
   • Click Install next to your organization or personal account.
   • On the next screen, you can choose to install the app on All repositories or Only select repositories.
   • Click Install to complete the process. The app can now interact with the selected repositories.

​

System Integration with ELITEA

​

Step 1: Create GitHub Credentials

1. Navigate to Credentials Menu: Open the sidebar and select Credentials.
2. Create New Credential: Click the + Create button.
3. Select GitHub: Choose GitHub as the credential type.
4. Configure Credential Details:
   • Display Name: Enter a descriptive name (e.g., “GitHub - Development Team Access”)
   • Base URL:
     • GitHub.com: leave empty to use the default https://api.github.com.
     • GitHub Enterprise Server: set your REST v3 endpoint, for example https://<your-ghes-domain>/api/v3.
   • Authentication Method: Choose your preferred authentication method:
     • Anonymous: No authentication required (limited to public repositories and rate-limited)
     • Token: Enter your GitHub Personal Access Token (recommended)
     • Password: Enter your GitHub username and password (not recommended)
     • App Private Key: Enter GitHub App ID and private key for app-based authentication
5. Test Connection: Click Test Connection to verify that your credentials are valid and ELITEA can successfully connect to GitHub
6. Save Credential: Click Save to create the credential. After saving, your GitHub credential will be added to the credentials dashboard and will be ready to use in toolkit configurations. You can view, edit, or delete it from the Credentials menu at any time.

​

Step 2: Create GitHub Toolkit

1. Navigate to Toolkits Menu: Open the sidebar and select Toolkits.
2. Create New Toolkit: Click the + Create button.
3. Select GitHub: Choose GitHub from the list of available toolkit types.
4. Configure Basic Information:
   • Toolkit Name: Enter a descriptive name for your toolkit (required). Example: “GitHub - ProjectAlita Repository”
   • Description: Provide an optional description to explain the toolkit’s purpose. Example: “Toolkit for managing ProjectAlita repository - handles code reviews, issue tracking, and automated deployments”
5. Configure Credentials:
   • In the Configuration section, select your previously created GitHub credential from the Credentials dropdown
6. Configure Advanced Options:
   • PgVector Configuration: Select a PgVector connection for vector database integration
   • Embedding Model: Select an embedding model for text processing and semantic search capabilities
7. Configure Repository Settings:
   • Repository: Enter the repository name in the format owner/repository-name (e.g., MyOrg/my-project)
   • Main Branch: Specify the main branch name (typically main or master)
   • Active Branch: Set the active working branch (defaults to main)
8. Enable Desired Tools: In the “Tools” section, select the checkboxes next to the specific GitHub tools you want to enable. Enable only the tools your agents will actually use to follow the principle of least privilege
   • Make Tools Available by MCP - (optional checkbox) Enable this option to make the selected tools accessible through the external MCP clients to use the toolkit’s capabilities
9. Save Toolkit: Click Save to create the toolkit.

​

Available Tools:

​

Testing Toolkit Tools

1. Select LLM Model: Choose a Large Language Model from the model dropdown in the Test Settings panel
2. Configure Model Settings: Adjust model parameters like Creativity, Max Completion Tokens, and other settings as needed
3. Select a Tool: Choose the specific GitHub tool you want to test from the available tools
4. Provide Input: Enter any required parameters or test queries for the selected tool
5. Run the Test: Execute the tool and wait for the response
6. Review the Response: Analyze the output to verify the tool is working correctly and returning expected results

​

Step 3: Add GitHub Toolkit to Your Workflows

​

In Agents:

1. Navigate to Agents: Open the sidebar and select Agents.
2. Create or Edit Agent: Either create a new agent or select an existing agent to edit.
3. Add GitHub Toolkit:
   • In the “TOOLKITS” section of the agent configuration, click the “+Toolkit” icon
   • Select your configured GitHub toolkit from the dropdown list
   • The toolkit will be added to your agent with the previously configured tools enabled

​

In Pipelines:

1. Navigate to Pipelines: Open the sidebar and select Pipelines.
2. Create or Edit Pipeline: Either create a new pipeline or select an existing pipeline to edit.
3. Add GitHub Toolkit:
   • In the “TOOLKITS” section of the pipeline configuration, click the “+Toolkit” icon
   • Select your configured GitHub toolkit from the dropdown list
   • The toolkit will be added to your pipeline with the previously configured tools enabled
   

​

In Chat:

1. Navigate to Chat: Open the sidebar and select Chat.
2. Start New Conversation: Click +Create or open an existing conversation.
3. Add Toolkit to Conversation:
   • In the chat Participants section, look for the Toolkits element
   • Click the “Add Tools” Icon to open the tools selection dropdown
   • Select your configured GitHub toolkit from the dropdown list
   • The toolkit will be added to your conversation with all previously configured tools enabled
4. Use Toolkit in Chat: You can now directly interact with your GitHub repositories by asking questions or requesting actions that will trigger the GitHub toolkit tools.

​

Instructions and Prompts for Using the GitHub Toolkit

​

Instruction Creation for Agents

• Direct and Action-Oriented: Employ strong action verbs and clear commands to initiate actions. For example, “Use the ‘read_file’ tool…”, “Create a branch named…”, “List all open pull requests…”.
• Parameter-Centric: Clearly enumerate each parameter required by the tool. For each parameter, specify:
  • Its name (exactly as expected by the tool)
  • The format or type of value expected
  • How the Agent should obtain the value – whether from user input, derived from previous steps in the conversation, retrieved from an external source, or a predefined static value
• Contextually Rich: Provide sufficient context so the Agent understands the overarching objective and the specific scenario in which each GitHub tool should be applied within the broader workflow. Explain the desired outcome or goal for each tool invocation.
• Step-by-Step Structure: Organize instructions into a numbered or bulleted list of steps for complex workflows. This helps the Agent follow a logical sequence of actions.
• Add Conversation Starters: Include example conversation starters that users can use to trigger this functionality. For example, “Conversation Starters: ‘Show me the README file’, ‘What’s in the README.md?’, ‘Display the project documentation’”

1. State the Goal: Begin by clearly stating the objective you want to achieve with this step. For example, “Goal: To retrieve the content of the ‘README.md’ file.”
2. Specify the Tool: Clearly indicate the specific GitHub tool to be used for this step. For example, “Tool: Use the ‘read_file’ tool.”
3. Define Parameters: Provide a detailed list of all parameters required by the selected tool. For each parameter:
   • Parameter Name: <Parameter Name as defined in tool documentation>
   • Value or Source: <Specify the value or how to obtain the value. Examples: "user input", "from previous step", "hardcoded value 'main'", "value of variable X">
4. Describe Expected Outcome (Optional but Recommended): Briefly describe the expected result or outcome after the tool is successfully executed. For example, “Outcome: The Agent will provide the content of the ‘README.md’ file.”
5. Add Conversation Starters: Include example conversation starters that users can use to trigger this functionality. For example, “Conversation Starters: ‘Show me the README file’, ‘What’s in the README.md?’, ‘Display the project documentation’”

1. Goal: Update the 'config.json' file in the 'settings' branch with new configuration values provided by the user.
2. Tool: Use the "update_file" tool.
3. Parameters:
   - Repository Name: "Specify the repository name in 'owner/repo' format. Use the repository configured in the GitHub toolkit."
   - File Path: "config.json"
   - Branch Name: "settings"
   - New Content: "Ask the user for the new JSON configuration content. Ensure it is valid JSON format. Example: {\"setting\": \"new_value\"}"
4. Outcome: The 'config.json' file in the 'settings' branch will be updated with the user-provided JSON configuration. Confirm the update to the user.

​

Chat Usage Examples by Tool Category

User: "I found a bug in the login system where users can't reset their passwords. Can you create an issue for this?"

Agent Response: I'll create a GitHub issue for the password reset bug you've identified.

[Agent uses create_issue tool]

✅ Issue created successfully!
- **Issue #47**: "Bug: Password reset not working in login system"
- **Description**: User reported that the password reset functionality is not working properly in the login system
- **Labels**: bug, login, high-priority
- **Status**: Open
- **URL**: https://github.com/yourorg/yourrepo/issues/47

The development team will be notified and can begin investigating this issue.

User: "What pull requests are currently open and waiting for review?"

Agent Response: Let me check the open pull requests in the repository.


Here are the currently open pull requests awaiting review:

📋 **Open Pull Requests** (3 total):

1. **PR #23**: "Add user authentication middleware"
   - **Author**: @johndev
   - **Branch**: feature/auth-middleware → main
   - **Created**: 2 days ago
   - **Status**: Ready for review

2. **PR #24**: "Fix database connection timeout"
   - **Author**: @sarah-engineer
   - **Branch**: bugfix/db-timeout → develop
   - **Created**: 1 day ago
   - **Status**: Draft

Would you like me to provide more details about any specific pull request?

User: "Can you show me the contents of the README.md file?"

Agent Response: I'll retrieve the README.md file from the repository for you.

[Agent uses read_file tool]

📄 **README.md Contents**:

```markdown
# Project Name

A comprehensive web application for managing user accounts and data.

## Features
- User authentication and authorization
- Data visualization dashboard
- RESTful API endpoints
- Real-time notifications

## Installation
```bash
npm install
npm start

User: "I need to create a new feature branch called 'user-profile-enhancement' based on the develop branch."

Agent Response: I'll create the new feature branch for you.

[Agent uses create_branch tool]

🌟 **Branch created successfully!**
- **Branch Name**: user-profile-enhancement
- **Based on**: develop branch

Would you like me to help you with any initial setup or file creation in this new branch?

User: "Show me the recent commits from the last week and summarize what changes were made."

Agent Response: Let me retrieve the recent commit history for you.

[Agent uses get_commits tool]

📈 **Recent Commits (Last 7 Days)**:

1. **Latest**: `a7b3f2c` - "Fix user login validation" 
   - **Author**: @johndev
   - **Date**: 2 hours ago
   - **Changes**: Updated authentication logic to handle edge cases

2. `9d4e1a8` - "Add responsive design for mobile devices"
   - **Author**: @ui-designer
   - **Date**: Yesterday
   - **Changes**: Implemented mobile-first CSS and responsive breakpoints

**Summary**: The team has been focusing on stability improvements, performance optimization, and mobile user experience enhancements this week.

User: "Please trigger the deployment workflow to push the latest changes to the staging environment."

Agent Response: I'll trigger the deployment workflow for the staging environment.

[Agent uses trigger_workflow tool]

🚀 **Deployment Workflow Triggered**:
- **Workflow**: "Deploy to Staging"
- **Trigger**: Manual (via ELITEA)
- **Branch**: main
- **Status**: Running
- **Workflow Run ID**: #12345

The deployment process has started and typically takes 3-5 minutes to complete. You can monitor the progress at:
https://github.com/yourorg/yourrepo/actions/runs/12345

I'll notify you once the deployment is complete. Would you like me to check the workflow status in a few minutes?

User: "Show me all the issues in our 'Sprint 23' project board."

Agent Response: Let me retrieve all issues from the Sprint 23 project board.

[Agent uses list_project_issues tool]

📊 **Sprint 23 Project Issues** (8 total):

**🔴 To Do** (3 issues):
- **Issue #45**: Implement user profile editing
  - **Assignee**: @frontend-dev
  - **Priority**: High
  - **Story Points**: 5
**🟡 In Progress** (3 issues):
- **Issue #42**: Database migration for user tables
- **Issue #43**: Integration tests for payment system
- **Issue #44**: Performance optimization

**🟢 Done** (2 issues):
- **Issue #40**: User authentication bug fix ✅
- **Issue #41**: Mobile responsive layout ✅

**Sprint Progress**: 25% complete (2/8 issues done)

User: "Search the codebase for any references to 'authentication' and 'security' to help me understand our current security implementation."

Agent Response: I'll search through the indexed repository content for authentication and security references.

[Agent uses search_index tool]

🔍 **Search Results for "authentication" and "security"**:

**📁 Authentication Files** (5 matches):
1. `src/auth/authentication.js` - Main authentication module
2. `src/middleware/auth.middleware.js` - Authentication middleware
3. `tests/auth.test.js` - Authentication unit tests
4. `docs/AUTH.md` - Authentication documentation
5. `config/auth.config.js` - Authentication configuration

**🔒 Security References** (8 matches):
1. `src/security/validation.js` - Input validation and sanitization
2. `src/security/encryption.js` - Password hashing and encryption
3. `src/middleware/security.headers.js` - Security headers middleware
4. `package.json` - Security-related dependencies
5. `docs/SECURITY.md` - Security guidelines and policies

**🔑 Key Implementation Patterns Found**:
- JWT token-based authentication
- bcrypt password hashing
- Rate limiting for login attempts
- CORS configuration
- Input validation middleware
- Security headers (CSRF, XSS protection)

Would you like me to read the contents of any specific files to dive deeper into the security implementation?

User: "Can you check the repository's current rate limit status using the GitHub API?"

Agent Response: I'll check the current GitHub API rate limit status for this repository.

[Agent uses generic_github_api_call tool]

📊 **GitHub API Rate Limit Status**:

**Core API**:
- **Limit**: 5,000 requests per hour
- **Used**: 1,247 requests
- **Remaining**: 3,753 requests
- **Reset Time**: 42 minutes from now

✅ **Status**: All APIs are within normal usage limits. You have plenty of requests remaining for continued GitHub operations.

​

Troubleshooting

​

Support Contact

​

FAQ