[DOCS] Document the `projects` Key Schema in `~/.claude.json`
Documentation Type
Missing documentation (feature not documented)
Documentation Location
_No response_
Section/Topic
Claude Code Settings Files
Current Documentation
https://code.claude.com/docs/en/claude-directory#ce-claude-json -- This is the only documentation I can find on the ~/.claude.json file.
What's Wrong or Missing?
There are certain aspects of the ~/.claude.json file that don't make sense to document as they appear to be some kind of feature flagging that is centrally and remotely managed. However, the projects key does not appear to be one of those aspects.
Instead, this key has many entries that are either directly or indirectly controlled by actions that I take when I use claude. e.g. claude mcp add ... and the mcpServers key (explicit) or by accepting the dialog/prompt asking if I trust the directory I have started Claude in and the hasTrustDialogAccepted key (implicit).
It would be nice if these keys and values were documented in more depth. Since projects are essentially just directories where Claude has been initiated, and since the information in the ~/.claude.json file has no mechanism for being cleaned up from stale information, it is not far fetched to imagine a scenario where I revisit a directory to begin working after a very long time and certain settings and permissions that were previously applied do not make sense to still be applied (the alternate fix here is to decouple the concept of a projects from a directory on the local file system, but that is clearly a massive ask and out of scope). If Claude isn't going to prune certain fields here for me, I would like to be equipped with the knowledge to do the pruning myself.
Suggested Improvement
- Document the
projectskey of~/.claude.json - (optional, but preferred) Document the entire
~/.claude.jsonfile. Make caveats for keyspaces that appear to be intentionally obscure e.g. everything in thecachedGrowthBookFeatureskey
Impact
Medium - Makes feature difficult to understand
Additional Context
_No response_
This issue has 3 comments on GitHub. Read the full discussion on GitHub ↗