this is a MCP server that create uml text based class diagrams, project tree structure and a list of modules anf functions in the project to assist cursor in understanding the project.
Overview
What is MCP Docs Tools?
MCP Docs Tools is a Node.js-based server that generates UML class diagrams, project tree structures, and documentation for module functions in Python projects, assisting developers in understanding their codebases.
How to use MCP Docs Tools?
To use MCP Docs Tools, clone the repository from GitHub, install the dependencies, and start the server. You can then call the tools via the Model Context Protocol (MCP).
Key features of MCP Docs Tools?
- Generates UML class diagrams from Python code.
- Creates a clean directory tree structure documentation.
- Documents module-level functions with signatures, decorators, and type hints.
- Zero configuration required for out-of-the-box usage.
- Smart exclusions for common files and directories that shouldn't be documented.
Use cases of MCP Docs Tools?
- Visualizing class relationships in Python projects through UML diagrams.
- Understanding project structure with directory tree documentation.
- Documenting functions for better code readability and maintenance.
FAQ from MCP Docs Tools?
- Can MCP Docs Tools be used with any Python project?
Yes! It is designed to work with any Python project that follows standard conventions.
- Is there any configuration needed to get started?
No, it works out of the box with sensible defaults.
- What are the system requirements?
You need Node.js (≥18.0.0) and Python 3.x for the tool to function.