Readme-builder-mcp
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
Features and capabilities supported by this server
Protocol revision2025-11-25
| Capability | Details |
|---|---|
| tools | {
"listChanged": true
} |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| detectRepoA | 读取指定目录的 package.json 并返回关键信息 |
| generateReadmeC | 根据项目信息生成 README Markdown（只读返回） |
| writeFileA | confirm=true 才会写入磁盘；否则只返回预览 |
| generateReadmeProB | 扫描指定目录并生成完整的 GitHub 风格 README（徽章、目录、脚本、结构、路由、环境变量、技术栈等） |
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
There is some overlap between generateReadme and generateReadmePro as both produce README markdown, though one uses provided project info and the other scans the directory. The descriptions help distinguish them, but agents may still be uncertain which to choose. detectRepo and writeFile are clearly distinct.
All tools follow a consistent verb_noun pattern: detectRepo, generateReadme, writeFile, and generateReadmePro. The 'Pro' suffix is a minor variant but does not disrupt the overall naming scheme, making the set predictable and readable.
With 4 tools, the server is well-scoped for its purpose. Each tool covers a necessary step in the README building workflow: analyzing a project, generating a basic or comprehensive README, and writing the output to disk. This is a reasonable and focused set.
The core lifecycle of README generation is covered: detect project info, generate a README, and write it. Minor gaps exist, such as no ability to update an existing README or customize sections further, but these are not essential for the primary goal of generating a README from scratch.