#Getting Started with GitHub Tools

This guide will help you set up and start using GitHub tools in the MCP Chat AI Assistant.

#🔗 Step 1: Connect Your GitHub Account

#Through Chat Settings

1. Click the Settings icon in the chat interface
2. Navigate to GitHub Integration
3. Click Connect GitHub Account
4. Authorize the application with your GitHub account
5. Grant necessary permissions

#Required Permissions

The GitHub integration requires these permissions:

• Repository access - Read and write to your repositories
• Issues - Create and manage issues
• Pull requests - Create and manage pull requests
• Contents - Read and modify file contents

#📁 Step 2: Select a Repository

#Method 1: Repository Selector

1. Look for the Repository Selector dropdown in the chat interface
2. Choose from your available repositories
3. The selected repository will be used for all GitHub operations

#Method 2: Ask the AI

"Show me my repositories" "Switch to the my-awesome-project repository" "What repositories do I have access to?"

#Repository Types Supported

• ✅ Public repositories - Full access
• ✅ Private repositories - Full access (with proper permissions)
• ✅ Organization repositories - Based on your organization role
• ✅ Forked repositories - Full access to your forks

#🎯 Step 3: Your First Request

Try these beginner-friendly commands:

#Explore Your Repository

"What files are in the root directory?" "Show me the structure of the src folder" "What languages are used in this project?"

#Read Code

"Show me the README file" "What's in the package.json file?" "Display the main entry point of this project"

#Get Repository Information

"Tell me about this repository" "What's the latest commit?" "How many open issues are there?"

#🔧 Understanding the Interface

#GitHub Connection Status

• 🟢 Connected - Green indicator shows active GitHub connection
• 🟡 Limited - Yellow indicates rate limiting (wait a moment)
• 🔴 Disconnected - Red means you need to reconnect

#Repository Context

• Current repository is displayed in the interface
• All operations will be performed on the selected repository
• Switch repositories anytime using the selector

#Rate Limiting

GitHub API has rate limits:

• 5,000 requests/hour for authenticated users
• The interface shows your remaining quota
• If you hit limits, wait or try again later

#💡 Tips for Success

#1. Be Specific

Instead of: "Show me the code" Try: "Show me the user authentication code in the auth folder"

#2. Use Natural Language

The AI understands context, so you can ask follow-up questions:

You: "Show me the main component" AI: [Shows component] You: "What props does this component accept?" AI: [Analyzes the component's props]

#3. Reference File Paths

You can reference files directly:

"Update the src/components/Button.tsx file to add a loading state" "Compare the old and new versions of config/database.js"

#4. Combine Operations

"Create a new feature branch called 'user-profile', then show me the components folder" "Find all TODO comments in the codebase and create an issue to track them"

#🚨 Common Setup Issues

#Issue: "Failed to connect to GitHub"

Solution:

1. Check your internet connection
2. Ensure you're logged into GitHub in your browser
3. Try disconnecting and reconnecting
4. Check if you have two-factor authentication enabled

#Issue: "Repository not found"

Solution:

1. Verify you have access to the repository
2. Check if the repository name is correct
3. Ensure the repository isn't private (unless you have access)
4. Try refreshing the repository list

#Issue: "Permission denied"

Solution:

1. Check repository permissions in GitHub
2. Verify the GitHub app has the necessary scopes
3. Contact the repository owner for access
4. Re-authorize the application with updated permissions

#📋 Quick Reference Commands

#✨ What's Next?

Now that you're connected, explore these advanced features:

1. File Operations - Learn to manage files and directories
2. Code Search - Master the search capabilities
3. AI Analysis - Discover AI-powered insights
4. Issue Management - Streamline your workflow

Ready to start building? Ask the AI assistant anything about your code!