MCP that writes README.md files for entire projects
ProjectDocumenter has 4 tools with basic verb-noun naming (generate-, document-, update-, assess-). All tools have descriptions (10-100 chars baseline met). However, input schemas are visible but minimal: only 1-2 parameters per tool with basic string/boolean types. No output schemas documented. Parameter descriptions are present but terse (e.g., 'Absolute path to the project directory'). No error handling guidance, no enums, no validation rules in descriptions. Tools lack idempotency hints, confirmation patterns for destructive operations (write risk), and chaining metadata. Composition is reasonable (4 distinct tools), but descriptions do not explain WHEN to use each tool vs. alternatives or what downstream tools need.
Review the quality of the README.md against modern documentation standards
Document a project by generating project.md and a comprehensive README.md
Create or update a project.md file that collects all relevant code for a project, respecting .gitignore
Update or create a README.md file with given content
No output schemas documented. LLMs cannot infer what fields to expect from tool responses, forcing unstructured parsing and risking context loss.
Parameter descriptions lack format/constraint details. E.g., 'Absolute path to the project directory' does not specify: must be absolute? must exist? must be readable? Relative paths rejected?
Destructive tools (generate-project-md, document-project, update-readme) lack confirmation or dry-run patterns. No guidance on recovery if files are overwritten unintentionally.
| Scored | Grade | Overall | Spec posture | Rubric |
|---|---|---|---|---|
| 2026-09-23 | F | 44 | 2026-07-28+ | v2 |
Error responses in code return raw error messages without recovery guidance. E.g., 'Error: Cannot access directory' does not suggest next steps (check path? check permissions?).
Tool descriptions do not explain WHEN to use each tool or how they relate. E.g., should an agent call generate-project-md then document-project, or just document-project? Unclear composition.