Readme Generator AI MCP
This server helps you automatically generate and enhance README documentation for software projects:
Generate a complete README.md (
generate_readme): Create a full README file from project metadata (name, description, language, features, author, license type), including sections for installation, usage, API reference, and contributing guidelines.Analyze project structure (
analyze_project): Provide a list of project files and the server will recommend appropriate README sections and detect the project type (e.g., library, CLI tool, API service).Suggest README sections (
suggest_sections): Get tailored section recommendations based on project type and capabilities (e.g., presence of an API, CLI, or Docker support).Generate shield.io badges (
generate_badges): Produce markdown badge snippets (license, version, build status, etc.) for a GitHub repository by providing the owner and repo name.
Interact with GitHub repositories to generate badge markdown based on repository metadata such as owner, repo name, version, and license.
Generate shield.io badges for inclusion in project README files.
Readme Generator Ai MCP
README
README.md generator MCP β analyse project structure, generate docs, badges, install instructions. MIT.
π Quick Start
# Install via pip
pip install readme_generator_ai_mcp
# Or install via Smithery
npx -y @smithery/cli@latest install readme-generator-ai-mcp --client claudeRelated MCP server: Commit Message AI MCP
β¨ Features
MCP protocol compliant
Easy installation
Well-documented API
Production-ready
Active maintenance
π Documentation
π‘οΈ Compliance
This MCP server is built with EU AI Act compliance built-in:
β Article 9 β Risk Management System
β Article 13 β Transparency & Instructions for Use
β Article 15 β Bias Detection & Testing
β Article 26 β FRIA Support (where applicable)
β Article 50 β AI Content Watermarking (where applicable)
Need help getting compliant? Book a free 15-min diagnostic β
π’ Enterprise
Need custom development, SLA guarantees, or white-label deployment?
Pro: $99/mo β Full MCP suite + EU AI Act tracking
Enterprise: $499/mo β Custom dev + SLA + Dedicated support
View Pricing β | Contact Sales β
π€ Part of the MEOK Ecosystem
This server is part of the MEOK AI Labs ecosystem β 300+ MCP servers for sovereign AI governance.
Domain | Purpose |
EU AI Act compliance marketplace | |
AI safety & monitoring | |
Sovereign AI platform | |
Legacy modernization |
π License
MIT Β© CSOAI-ORG
Pairs with MEOK Governance Suite
Build something that touches users? You need compliance. MEOK ships 38 governance MCPs that drop in alongside this tool β EU AI Act, DORA, NIS2, CRA, GDPR, ISO 42001, FDA SaMD, MDR, Basel, MiFID II, MiCA, COPPA, and more.
# One-shot install of the governance pack
npx meok-setup --pack governanceFree tier: 10 calls/day per MCP. Pro tier (Β£79/mo): unlimited + cryptographically signed compliance attestations your auditor verifies independently.
β Full catalogue: councilof.ai/catalogue β MEOK AI Labs: meok.ai
πΈ Try MEOK in 30 seconds β instant buy ladder
Tier | Price | What you get | Stripe |
Smoke test | Β£1 | Signed sample MCP-Hardening report + Article 50 PDF | |
Quick Kit | Β£9 | EU AI Act Article 50 implementation guide (C2PA + EU-Icon) | |
Founder Call | Β£29 | 30-min 1-on-1 with the founder |
Refundable. UK Stripe β VAT-clean. Builds on the 81-MCP MEOK fleet. Verify any signed report at https://meok.ai/verify.
Configuration
Add to your claude_desktop_config.json (Claude Desktop) or your MCP client config:
{
"mcpServers": {
"readme-generator-ai-mcp": {
"command": "uvx",
"args": ["readme-generator-ai-mcp"]
}
}
}Or: pip install readme-generator-ai-mcp then run the readme-generator-ai-mcp command (stdio transport).
Examples
Once configured, ask your assistant, for example:
"Use
generate_readmeto β¦""Use
analyze_projectto β¦""Use
suggest_sectionsto β¦"
Available Tools
4 toolsanalyze_projectA
Analyze project structure from a file list to recommend README sections and detect project type.
Behavior: This tool is read-only and stateless β it produces analysis output without modifying any external systems, databases, or files. Safe to call repeatedly with identical inputs (idempotent). Free tier: 10/day rate limit. Pro tier: unlimited. No authentication required for basic usage.
When to use: Use this tool when you need structured analysis or classification of inputs against established frameworks or standards.
When NOT to use: Not suitable for real-time production decision-making without human review of results.
Args: file_list (str): The file list to analyze or process. language (str): The language to analyze or process. api_key (str): The api key to analyze or process.
Behavioral Transparency: - Side Effects: This tool is read-only and produces no side effects. It does not modify any external state, databases, or files. All output is computed in-memory and returned directly to the caller. - Authentication: No authentication required for basic usage. Pro/Enterprise tiers require a valid MEOK API key passed via the MEOK_API_KEY environment variable. - Rate Limits: Free tier: 10 calls/day. Pro tier: unlimited. Rate limit headers are included in responses (X-RateLimit-Remaining, X-RateLimit-Reset). - Error Handling: Returns structured error objects with 'error' key on failure. Never raises unhandled exceptions. Invalid inputs return descriptive validation errors. - Idempotency: Fully idempotent β calling with the same inputs always produces the same output. Safe to retry on timeout or transient failure. - Data Privacy: No input data is stored, logged, or transmitted to external services. All processing happens locally within the MCP server process.
Inputs: file_list (required), language, api_key. Returns: result
generate_badgesB
Generate shield.io badge markdown for a GitHub repository.
Behavior: This tool generates structured output without modifying external systems. Output is deterministic for identical inputs. No side effects. Free tier: 10/day rate limit. Pro tier: unlimited. No authentication required for basic usage.
When to use: Use this tool when you need structured analysis or classification of inputs against established frameworks or standards.
When NOT to use: Not suitable for real-time production decision-making without human review of results.
Args: owner (str): The owner to analyze or process. repo (str): The repo to analyze or process. badges (str): The badges to analyze or process. version: The version to analyze or process. build": The build" to analyze or process. license_type (str): The license type to analyze or process. version (str): The version to analyze or process. api_key (str): The api key to analyze or process.
Behavioral Transparency: - Side Effects: This tool is read-only and produces no side effects. It does not modify any external state, databases, or files. All output is computed in-memory and returned directly to the caller. - Authentication: No authentication required for basic usage. Pro/Enterprise tiers require a valid MEOK API key passed via the MEOK_API_KEY environment variable. - Rate Limits: Free tier: 10 calls/day. Pro tier: unlimited. Rate limit headers are included in responses (X-RateLimit-Remaining, X-RateLimit-Reset). - Error Handling: Returns structured error objects with 'error' key on failure. Never raises unhandled exceptions. Invalid inputs return descriptive validation errors. - Idempotency: Fully idempotent β calling with the same inputs always produces the same output. Safe to retry on timeout or transient failure. - Data Privacy: No input data is stored, logged, or transmitted to external services. All processing happens locally within the MCP server process.
Inputs: owner (required), repo (required), badges, license_type, +2 more. Returns: result
generate_readmeA
Generate a complete README.md from project metadata including sections for install, usage, API, and contributing.
Behavior: This tool generates structured output without modifying external systems. Output is deterministic for identical inputs. No side effects. Free tier: 10/day rate limit. Pro tier: unlimited. No authentication required for basic usage.
When to use: Use this tool when you need structured analysis or classification of inputs against established frameworks or standards.
When NOT to use: Not suitable for real-time production decision-making without human review of results.
Args: project_name (str): The project name to analyze or process. description (str): The description to analyze or process. language (str): The language to analyze or process. features (str): The features to analyze or process. author (str): The author to analyze or process. license_type (str): The license type to analyze or process. api_key (str): The api key to analyze or process.
Behavioral Transparency: - Side Effects: This tool is read-only and produces no side effects. It does not modify any external state, databases, or files. All output is computed in-memory and returned directly to the caller. - Authentication: No authentication required for basic usage. Pro/Enterprise tiers require a valid MEOK API key passed via the MEOK_API_KEY environment variable. - Rate Limits: Free tier: 10 calls/day. Pro tier: unlimited. Rate limit headers are included in responses (X-RateLimit-Remaining, X-RateLimit-Reset). - Error Handling: Returns structured error objects with 'error' key on failure. Never raises unhandled exceptions. Invalid inputs return descriptive validation errors. - Idempotency: Fully idempotent β calling with the same inputs always produces the same output. Safe to retry on timeout or transient failure. - Data Privacy: No input data is stored, logged, or transmitted to external services. All processing happens locally within the MCP server process.
Inputs: project_name (required), description (required), language, features, +3 more. Returns: result
suggest_sectionsA
Suggest appropriate README sections based on project type and capabilities.
Behavior: This tool is read-only and stateless β it produces analysis output without modifying any external systems, databases, or files. Safe to call repeatedly with identical inputs (idempotent). Free tier: 10/day rate limit. Pro tier: unlimited. No authentication required for basic usage.
When to use: Use this tool when you need structured analysis or classification of inputs against established frameworks or standards.
When NOT to use: Not suitable for real-time production decision-making without human review of results.
Args: project_type (str): The project type to analyze or process. has_api (bool): The has api to analyze or process. has_cli (bool): The has cli to analyze or process. has_docker (bool): The has docker to analyze or process. api_key (str): The api key to analyze or process.
Behavioral Transparency: - Side Effects: This tool is read-only and produces no side effects. It does not modify any external state, databases, or files. All output is computed in-memory and returned directly to the caller. - Authentication: No authentication required for basic usage. Pro/Enterprise tiers require a valid MEOK API key passed via the MEOK_API_KEY environment variable. - Rate Limits: Free tier: 10 calls/day. Pro tier: unlimited. Rate limit headers are included in responses (X-RateLimit-Remaining, X-RateLimit-Reset). - Error Handling: Returns structured error objects with 'error' key on failure. Never raises unhandled exceptions. Invalid inputs return descriptive validation errors. - Idempotency: Fully idempotent β calling with the same inputs always produces the same output. Safe to retry on timeout or transient failure. - Data Privacy: No input data is stored, logged, or transmitted to external services. All processing happens locally within the MCP server process.
Inputs: project_type (required), has_api, has_cli, has_docker, +1 more. Returns: result
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelogβ¦
TDQS
Scored across 4 tools
Each tool has a clearly distinct purpose: analyze_project examines file lists, generate_badges creates badge markdown, generate_readme produces a full README, suggest_sections recommends sections. No overlap.
All tool names follow a consistent verb_noun pattern (analyze_project, generate_badges, generate_readme, suggest_sections) using lowercase and underscores.
With 4 tools covering analysis, suggestion, badge generation, and full README generation, the count is well-scoped for a README generatorβneither too few nor too many.
The tool set covers the full lifecycle of README creation: analyzing project structure, suggesting sections, generating badges, and producing the complete README. No obvious gaps.
Maintenance
Related MCP Connectors
MCP server for Qwen Image 3 AI image generation
MCP server for Flux AI image generation
An MCP server that gives your AI access to the source code and docs of all public github repos
AI tool directory MCP server, live since July 2026. Tools, agents, models, companies, services.
Related MCP Servers
- AlicenseNot gradedqualityCmaintenanceGit Helper AI - MCP server providing AI-powered tools and automation by MEOK AI Labs9 npm37 PyPIMIT
- AlicenseAqualityCmaintenanceCommit Message AI - MCP server providing AI-powered tools and automation by MEOK AI Labs46 npm44 PyPIMIT
- AlicenseNot gradedqualityCmaintenanceCode Reviewer AI - MCP server providing AI-powered tools and automation by MEOK AI Labs6 npm37 PyPIMIT
- AlicenseAqualityCmaintenanceAPI Docs Generator AI - MCP server providing AI-powered tools and automation by MEOK AI Labs54 npm66 PyPIMIT