README Generator MCP Server
Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Instructions
Guidance the server publishes about itself, which clients place ahead of the tool catalog so the model reads it before choosing anything.
This server publishes no instructions, or was last inspected before Glama recorded them.
Capabilities
Server capabilities have not been inspected yet.
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| read_project_structureB | Read the directory structure of a project. Returns a tree-like structure of files and folders. |
| read_fileC | Read the contents of a file |
| analyze_projectA | Analyze a project directory and return structured data about the project along with a README template. Returns: (1) A template structure with recommended README sections (some required, some optional), and (2) Detailed project analysis including detected technologies, package.json data, directory structure, scripts, dependencies, and configuration files. The LLM should use this information to construct a comprehensive README following the template structure as a guide, adapting sections based on what's relevant for the specific project. |
| generate_readmeB | Generate a well-formatted, visually appealing README.md file for a project. This tool analyzes the project directory and automatically creates a comprehensive README with: badges, emojis, proper sections (description, installation, usage, project structure, dependencies, etc.), code blocks, and professional formatting. The generated README is ready to use and follows best practices. |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |
TDQS
Scored across 4 tools
Multiple tools have unclear boundaries, particularly analyze_project and generate_readme, which both analyze the project directory and generate README-related outputs, causing potential confusion. While read_file and read_project_structure are more distinct, the overlap between the first two tools is significant and could lead to misselection.
The tool names follow a mostly consistent verb_noun pattern (e.g., analyze_project, generate_readme, read_file, read_project_structure), with only minor deviations in verb choice. This consistency aids in readability and predictability across the set.
With 4 tools, the count is borderline for the server's purpose of README generation; it feels thin as it lacks operations like updating or deleting READMEs, and the overlap between tools suggests redundancy rather than comprehensive coverage. A well-scoped set for this domain might include more distinct actions.
There are significant gaps in the tool surface for README generation, such as missing update or delete operations for README files, and no tools for validating or customizing READMEs beyond generation. The overlap between analyze_project and generate_readme further indicates incomplete coverage, as agents may struggle with dead ends in workflows.