GitHub MCP Connection¶
Overview¶
The GitHub Model Context Protocol (MCP) server provides natural language access to GitHub repositories, issues, pull requests, and other GitHub platform features through WorkBuddy. This remote MCP server enables AI assistants to interact with GitHub without requiring local package installation.
Key Features: - Repository browsing and search - Issue and pull request management - Code review assistance - Repository statistics and insights - Team collaboration workflows
Connection Type¶
Remote MCP Server – Connects to GitHub's hosted MCP endpoint at https://api.githubcopilot.com/mcp/
Prerequisites¶
- GitHub Account: A GitHub account with appropriate repository access
- GitHub Copilot Access: GitHub Copilot subscription or organizational access
- API Access: GitHub API access (typically included with Copilot)
- Network Access: Ability to reach
https://api.githubcopilot.com/ - WorkBuddy: Desktop version with MCP support enabled
Configuration¶
1. MCP Server Registration¶
Update your WorkBuddy MCP configuration (~/.workbuddy/mcp.json):
{
"mcpServers": {
"github": {
"timeout": 600,
"url": "https://api.githubcopilot.com/mcp/"
}
}
}
2. Authentication Setup¶
GitHub MCP uses GitHub Copilot authentication. Ensure you're signed into GitHub Copilot in your browser or have the appropriate authentication tokens configured in WorkBuddy.
Environment Variables (optional, if required by your setup):
GITHUB_TOKEN=your_personal_access_token
GITHUB_ENTERPRISE_URL=https://github.yourcompany.com
3. Verify Connection¶
After updating mcp.json and restarting WorkBuddy (or reloading MCP servers), verify the connection:
- Check WorkBuddy logs for MCP initialization messages
- Try a simple GitHub query through WorkBuddy: "What are my recent GitHub notifications?"
Usage Examples¶
Repository Operations¶
User: "Show me the open issues in the workbuddy-config repository"
Assistant: (Lists open issues with titles and assignees)
User: "Create a new issue about documentation updates"
Assistant: (Creates issue with specified title and description)
User: "What's the latest pull request status for feature/auth?"
Assistant: (Provides PR status, checks, and review status)
Code Review Assistance¶
User: "Review the changes in pull request #42"
Assistant: (Summarizes changes, identifies potential issues)
User: "Suggest improvements for the authentication module"
Assistant: (Provides code suggestions based on repository context)
Team Collaboration¶
User: "Assign issue #15 to John and add the 'bug' label"
Assistant: (Updates issue assignment and labels)
User: "Schedule a code review meeting for next week"
Assistant: (Creates calendar event or reminder)
Supported Operations¶
| Operation | Description | Required Permissions |
|---|---|---|
| Repository Read | List repos, view code, read issues | Read access |
| Repository Write | Create issues, PRs, comments | Write access |
| Code Review | Review PRs, suggest changes | Write access |
| Team Management | Assign issues, manage projects | Admin or write access |
| Analytics | Repository statistics, contribution graphs | Read access |
Troubleshooting¶
Connection Issues¶
- Cannot Connect to MCP Endpoint
Error: Failed to connect to https://api.githubcopilot.com/mcp/ - Verify network connectivity to GitHub domains
- Check firewall/proxy settings
-
Ensure GitHub Copilot service is available
-
Authentication Required
Error: Authentication required for GitHub MCP - Sign into GitHub Copilot in your browser
- Verify GitHub Copilot subscription is active
-
Check organizational access permissions
-
Rate Limiting
Error: API rate limit exceeded - GitHub API has rate limits for authenticated and unauthenticated requests
- Consider using a GitHub personal access token for higher limits
- Implement caching for frequently accessed data
Configuration Validation¶
Verify MCP configuration syntax:
# Check JSON syntax
python -m json.tool ~/.workbuddy/mcp.json
Security Considerations¶
Token Management¶
- Use fine-grained personal access tokens with minimal required permissions
- Store tokens in environment variables, not in version control
- Regularly rotate access tokens
Repository Access¶
- Grant repository access based on the principle of least privilege
- Use repository-specific tokens for sensitive repositories
- Audit repository access permissions regularly
Data Privacy¶
- GitHub MCP may process repository content through GitHub Copilot infrastructure
- Review GitHub Copilot privacy and data processing terms for your organization
- Consider using GitHub Enterprise for additional control
Integration with Other Services¶
WorkBuddy Skills¶
Combine GitHub MCP with other WorkBuddy skills: - CI/CD Integration: Trigger builds on PR merge - Documentation Sync: Update documentation when code changes - Project Management: Sync GitHub issues with project tracking tools
Organizational Workflows¶
- Code Review Automation: Automate review assignment and reminders
- Release Management: Coordinate releases across multiple repositories
- Onboarding: Guide new developers through repository setup
Performance Optimization¶
Caching¶
- Enable caching for repository metadata where appropriate
- Cache issue lists and PR status to reduce API calls
- Implement incremental updates for large repositories
Batch Operations¶
- Use batch API calls for multiple related operations
- Schedule background updates for non-time-sensitive data
- Prioritize real-time updates for active development branches
Related Resources¶
- GitHub API Documentation
- GitHub Copilot Documentation
- Canonical MCP Structures – Standardized setup patterns
- WorkBuddy GitHub Skill – Additional GitHub capabilities
Support¶
GitHub Support¶
WorkBuddy Support¶
- WorkBuddy logs for MCP connection issues
- Organization platform team for internal support
- WorkBuddy Documentation
Last Updated: 2026‑05‑19
Maintainer: Platform Team
Connection Type: Remote MCP Server
Authentication: GitHub Copilot / Personal Access Token
Status: 🔧 Configuration Required