Provides tools for analyzing GitHub projects, generating comprehensive README files, and extracting project insights and statistics.
Enables analysis of Python projects, including structure scanning and file content reading to support project documentation.
Supports parsing and analysis of TOML configuration files in projects, as evidenced by the project structure including pyproject.toml.
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., "@MCP Server Demoscan my project and generate a README for it"
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.
MCP Server Demo
A demonstration MCP (Model Context Protocol) server that provides tools for project analysis and README generation.
Features
Project Structure Analysis: Scan and analyze project directories
File Reading: Read contents of specific files
README Generation: Automatically generate comprehensive README files
Project Information: Get detailed project insights and statistics
Related MCP server: SourceSage MCP
Installation
Clone the repository
Install dependencies (if any):
pip install -r requirements.txt
Usage
Run the MCP server:
python github_readme.pyThe server provides the following tools:
scan_project(project_path)- Analyze project structureread_file(file_path)- Read file contentsgenerate_readme(project_path, project_name, description)- Generate READMEsave_readme(project_path, readme_content)- Save README to file
Project Structure
├── github_readme.py # Main MCP server implementation
├── pyproject.toml # Project configuration
└── uv.lock # Lock fileRequirements
Python 3.13+
MCP (Model Context Protocol) framework (Like Claude Desktop..)
This server cannot be installed
Resources
Unclaimed servers have limited discoverability.
Looking for Admin?
If you are the server author, to access and configure the admin panel.