microsoft--ai-agents-for-beginners/11-agentic-protocols/code_samples/github-mcp/MCP_SETUP.md

MCP Server Integration Guide

Prerequisites

• Node.js installed (version 14 or higher)
• npm package manager
• Python environment with required dependencies

Setup Steps

1. Install MCP Server Package

   npm install -g @modelcontextprotocol/server-github
   

2. Start MCP Server

   npx @modelcontextprotocol/server-github
   

   The server should start and display a connection URL.

3. Verify Connection

   • Look for the plug icon (🔌) in your Chainlit interface
   • A number (1) should appear next to the plug icon indicating successful connection
   • The console should show: "GitHub plugin setup completed successfully" (along with additional status lines)

Troubleshooting

Common Issues

1. Port Conflict

   Error: listen EADDRINUSE: address already in use
   

   Solution: Change the port using:

   npx @modelcontextprotocol/server-github --port 3001
   

2. Authentication Issues

   • Ensure GitHub credentials are properly configured
   • Check .env file contains required tokens
   • Verify GitHub API access

3. Connection Failed

   • Confirm server is running on expected port
   • Check firewall settings
   • Verify Python environment has required packages

Connection Verification

Your MCP server is properly connected when:

1. Console shows "GitHub plugin setup completed successfully"
2. Connection logs show "✓ MCP Connection Status: Active"
3. GitHub commands work in chat interface

Environment Variables

Required in your .env file:

GITHUB_TOKEN=your_github_token
MCP_SERVER_PORT=3000  # Optional, default is 3000

Testing Connection

Send this test message in chat:

Show me the repositories for username: [GitHub Username]

A successful response will show repository information.