Skip to main content
Glama
Readme Generator AI MCP

Readme Generator AI MCP

MCP Scorecard: 74/100

Readme Generator Ai MCP

MEOK AI Labs GSPC License PyPI

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 claude

Related 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

councilof.ai

EU AI Act compliance marketplace

safetyof.ai

AI safety & monitoring

meok.ai

Sovereign AI platform

cobolbridge.ai

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 governance

Free 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

https://buy.stripe.com/5kQ6oJ0xS3ce8sl7ew8k91j

Quick Kit

Β£9

EU AI Act Article 50 implementation guide (C2PA + EU-Icon)

https://buy.stripe.com/5kQ6oJ0xS3ce8sl7ew8k91j

Founder Call

Β£29

30-min 1-on-1 with the founder

https://buy.stripe.com/5kQ6oJ0xS3ce8sl7ew8k91j

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_readme to …"

  • "Use analyze_project to …"

  • "Use suggest_sections to …"

Available Tools

4 tools
analyze_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

    A4.2/5.0

    Scored across 4 tools

    Disambiguation5/5

    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.

    Naming Consistency5/5

    All tool names follow a consistent verb_noun pattern (analyze_project, generate_badges, generate_readme, suggest_sections) using lowercase and underscores.

    Tool Count5/5

    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.

    Completeness5/5

    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

    ActivityNo data
    ResponsivenessOutdated data

    Related MCP Connectors

    Related MCP Servers