Skip to content

docs_generate_readme produces generic content — doesn't use project metadata #97

Description

@wtthornton

Summary

The generated README is too generic. It suggests pip install server-agent (not on PyPI), git clone <repository-url> (placeholder), and describes features as "Python project with modern packaging" without mentioning MCP, Claude, or server management.

Specific gaps

  1. Install instructions: Suggests pip install — should detect uv.lock / .python-version and recommend uv sync
  2. Clone URL: Uses <repository-url> placeholder — should read git remote get-url origin
  3. Features: Generic — should pull from pyproject.toml description and detect key dependencies (MCP, Anthropic, etc.)
  4. Usage: Empty beyond the package name — should detect CLI subcommands from click/typer decorators or [project.scripts]
  5. No mention of what makes the project unique: MCP tools, Claude integration, server management — none appear

Suggestion

Enrich the README generator with:

  • git remote for clone URL
  • pyproject.toml [project] description and keywords
  • Dependency scanning for notable frameworks (MCP, FastAPI, Django, etc.)
  • CLI subcommand detection from entry points
  • uv.lock detection for install method

Metadata

Metadata

Assignees

No one assigned

    Labels

    P1High prioritydocs-mcpDocsMCP packageenhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions