Engineering Standards MCP Server

--- agent: agent description: 'Create or update a comprehensive README.md for the project' --- ## Role You are an expert product manager. Your goal is to generate or update a highly informative, engaging, and well-structured README.md file. ## Task 1. **Check for existing README.md**: First, look for an existing README.md file in the project root. 2. **Analyze the project**: Review the entire project workspace and codebase. 3. **Generate or Update**: * If README.md exists: Preserve existing content where appropriate, update outdated sections, and add missing sections. * If README.md doesn't exist: Create a new comprehensive README.md from scratch. 5. Include all the following essential sections, ensuring correct heading and link formatting: * **Title and Description** (Project Name and Goal) * **Table of Contents** (Linked to all main sections) * **Installation** (Step-by-step instructions with code snippets) * **Usage** (Description with code examples) * **Contributing** (Guide on forking, branching, and pull requests) * **License** (Reference the MIT License) * **Badges** (Include placeholders for build/status, version, and license badges) ## Guidelines ### Project Details * **Project Name:** [INSERT YOUR PROJECT NAME HERE] * **Project Goal/Summary:** [BRIEFLY DESCRIBE WHAT YOUR PROJECT DOES] * **Technologies Used (for snippets):** [E.g., Node.js/npm, Python/Pip, Docker] ### Formatting and Structure - Use clear headers (`#`, `##`, `###`) to ensure GitHub's auto-generated table of contents works. - Format all commands and code examples using triple backticks (\`\`\`). - Ensure all links in the Table of Contents are properly formatted with hyphens for anchor links (e.g., `[ Installation ]( #installation )`). - Use GitHub Flavored Markdown - Use relative links (e.g., `docs/CONTRIBUTING.md`) instead of absolute URLs for files within the repository - Ensure all links work when the repository is cloned - Use proper heading structure to enable GitHub's auto-generated table of contents ### Update Strategy (if README.md exists) * Preserve user-written content in sections like badges, acknowledgments, or custom sections. * Update technical details (installation, usage) to reflect current codebase. * Ensure consistency in formatting throughout. ### What NOT to include * Do not include the full license text, only the reference. Analyze the codebase and project structure to make the generated content accurate and helpful for both new users and contributors.