Provides tools for accessing GitHub repository information and reading file content from repositories using the GitHub REST API.
Click on "Install Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@Simple Code Review Assistantsearch the docs for error handling best practices"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
π§ Simple Code Review Assistant - MCP Assignment
Assignment Duration: 6-8 Hours
Target Audience: Intermediate Level Developers
Focus: Model Context Protocol (MCP) Basics
π― Learning Objectives
By completing this assignment, you will:
Build a basic MCP server using Model Context Protocol
Implement simple tool interfaces for AI models
Practice GitHub API integration
Understand how AI models connect to external data sources
π Prerequisites
Python 3.11+ experience
Basic understanding of REST APIs
Familiarity with GitHub API
Basic knowledge of AI/LLM concepts
π Quick Start
1. Environment Setup
# Clone and navigate to project
cd MCPAssignment
# Create virtual environment
python3 -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
# Install dependencies
pip install -r requirements.txt2. Configuration
Create .env file in the project root:
GITHUB_TOKEN=your_github_token_here
GITHUB_REPO_OWNER=your_github_username
GITHUB_REPO_NAME=your_repository_name3. Run the MCP Server
# Start the MCP Server
python server.py
# Test the server (in another terminal)
python client.pyπ Project Structure
mcp-code-review/
βββ README.md # Your implementation documentation
βββ requirements.txt # Dependencies
βββ .env.example # Environment template
βββ server.py # Single MCP Server file
βββ client.py # Simple client to test server
βββ docs/
βββ api_guide.md # Sample documentation
βββ setup_guide.md # Sample documentationποΈ System Architecture
MCP Tools (Keep it Simple!)
Tool | Purpose | Implementation |
get_repository | Get repo info from GitHub | GitHub API call |
search_docs | Search local documentation | Simple file search |
get_file_content | Read file from repo | GitHub API call |
Simple Flow
Client β MCP Server β GitHub API / Local Files β Responseπ Core Requirements (Simplified)
Must-Have Features (6-8 hours scope)
Basic MCP Server
Implement ONE MCP server file (
server.py)Support 3 simple tools (listed above)
Follow basic MCP protocol
Handle errors gracefully
GitHub Integration
Connect to GitHub API using token
Implement
get_repositorytoolImplement
get_file_contenttoolAdd basic rate limiting
Documentation Search
Implement
search_docstool for local filesSearch through markdown files in
/docsfolderReturn relevant file content
Support simple keyword matching
Simple Client
Create
client.pyto test your MCP serverDemonstrate all 3 tools working
Show real GitHub data retrieval
Display search results
π§ Implementation Steps
Step 1: Setup
pip install mcp requests
# Create basic file structure
# Setup GitHub tokenStep 2: Basic MCP Server
Implement MCP protocol basics
Add the 3 required tools
Test with simple responses
Step 3: GitHub Integration
Connect to GitHub API
Implement repository and file tools
Add error handling
Step 4: Documentation Search
Create simple file search
Add sample documentation files
Test search functionality
Step 5: Client & Testing
Build simple client
Test all tools
Create demo
π Submission Requirements (Minimal)
Required Files
β
server.py- Working MCP serverβ
client.py- Simple test clientβ
requirements.txt- Dependenciesβ
.env.example- Environment templateβ Sample docs in
/docsfolder
Demo Requirements
β Show MCP server starting up
β Demonstrate GitHub repository access
β Show documentation search working
β Explain your implementation approach
π Resources
π§ Development Commands
# Start MCP Server
python server.py
# Test with client (in another terminal)
python client.py --test-all
# Test individual tools
python client.py --test-github
python client.py --test-docs