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.
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
Installation
- Clone the repository
- Install dependencies (if any):
Usage
Run the MCP server:
The 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
Requirements
- Python 3.13+
- MCP (Model Context Protocol) framework (Like Claude Desktop..)
This server cannot be installed
local-only server
The server can only run on the client's local machine because it depends on local resources.
A demonstration server that provides tools for analyzing project structures and automatically generating comprehensive README files.
Related MCP Servers
- AsecurityAlicenseAqualityProvides HTML file preview and analysis capabilities. This server enables capturing full-page screenshots of local HTML files and analyzing their structure.Last updated -219JavaScriptMIT License
- AsecurityFlicenseAqualityA TypeScript-based server that visualizes project directory structures in Markdown format, automatically documenting file contents with syntax highlighting and supporting customizable exclusion patterns.Last updated -12482TypeScript
- AsecurityAlicenseAqualitytest server to see how clients handle a lot of toolsLast updated -8,8163PythonMIT License
- -securityAlicense-qualityProvides tools for analyzing project structures, searching through codebases, managing dependencies, and performing file operations with advanced filtering capabilities.Last updated -291TypeScriptMIT License