Skip to content

README.md's faircode/ repo-tree omits mcp_server.py, _explainers/, and _results_frozen/ #409

Description

@yakew7

Where: README.md's faircode/ repo-tree block.

The gap: the tree enumerates every file under faircode/ (SPEC.md, cli.py, profiler.py, ...) but omits faircode/mcp_server.py - the module behind the faircode-mcp console script (pyproject.toml's [project.scripts]) - entirely, along with the two new package-internal generated directories faircode/_explainers/ and faircode/_results_frozen/ (declared as real package-data in pyproject.toml, added this session for the MCP server's Phase 2 read-only lookup tools).

Repro:

grep -n "mcp_server\|_explainers/\|_results_frozen/" README.md

returns zero matches.

Why it matters: mcp_server.py is a ~500-line module exposing six MCP tools - not a minor file - and its own package-data mirrors are load-bearing for those tools to work at all in a real pip install. A reader using README's tree to orient themselves has no idea any of this exists.

Suggested fix: add mcp_server.py, _explainers/ (with a one-line note it's a generated mirror of explainers/*.md), and _results_frozen/ (generated mirror of paper/results-frozen/*.csv) to the tree, matching the existing style for other generated files like assets/explainers-data.js.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomershelp wantedExtra attention is needed

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions