SET IT UP
From install to the first answer
-
Install ClarifyDoc and connect Cursor
The CLI is on npm and needs Node.js. From the project root, the second command merges the entry into Cursor’s config and keeps everything else in it. Add
--printto see what it would write first.npm install -g clarifydoc && clarifydoc install . --client cursorWith the VS Code extension instead: Cursor installs the extension from Open VSX. Its ClarifyDoc: Set Up MCP for an AI Agent… → Cursor writes this entry — into the project’s
.cursor/mcp.jsonwhen there is one, else into~/.cursor/mcp.json— pointed at the extension’s own launcher, so no Node.js is needed. -
Where the entry goes
.cursor/mcp.json in the projectThe entry names no project: the server serves the folder Cursor runs in, so the same file works for everyone who opens the project.
{ "mcpServers": { "clarifydoc": { "command": "clarifydoc", "args": [ "mcp" ] } } } -
Reload Cursor
Cursor reads
.cursor/mcp.jsonwhen the project opens. Open Cursor’s settings at the MCP section and make sureclarifydocis switched on; reload the window if it does not appear. -
Ask the first question
Type this as it is. If the project has no analysis yet, the first call makes one; a large repository can take a few minutes, and every analysis after it reads only the files that changed. To have it ready first, run
clarifydoc analyze .from the project root.Call clarifydoc_status, then use clarifydoc_routes to pick one API route. Tell me which screen calls it and which tables it reads and writes, with path:line for each.Then one about your own change:
Before I change <a file you know>, what depends on it and which tests should I run? -
Check that it worked
clarifydoc_statusanswers with the project root, when it was analyzed and how many routes, screens and tables were found. If it says no analysis was found, the server is looking at another folder: start Cursor from the project root.Cursor’s MCP settings list
clarifydocwith its tools and a status dot. -
Keep it current
Ask the agent to call
clarifydoc_analyze, or runclarifydoc analyze . --incremental: either re-reads only the files that changed.clarifydoc install --git-hooksdoes it in the background after each commit, merge and branch checkout. To update ClarifyDoc itself,npm install -g clarifydoc@latest(the extension updates itself, and its launcher keeps its path), then reload Cursor. -
Remove it
Delete the
clarifydocentry from.cursor/mcp.json(or~/.cursor/mcp.json). Delete.clarifydoc/in the project, andnpm uninstall -g clarifydoc. If you asked for them,--guidancewrote between<!-- clarifydoc:start -->and<!-- clarifydoc:end -->inAGENTS.md, and--git-hooksbetween# clarifydoc:startand# clarifydoc:endin the repository’s git hooks. Nothing else is written.
OPTIONAL
More than the server
Each is a flag on the same clarifydoc install command, off unless you ask for it, and --print shows it before anything is written.
A section in AGENTS.md
--guidance adds a short, marked section to AGENTS.md that tells agents when to ask the map instead of searching text, and what this project’s analysis says to know first. It edits a file your team shares, so --print it first.
WHAT IT ANSWERS
23 tools, all read-only but two
Routes and who calls them, the tables a screen reads and writes, the call path between two functions, what a diff reaches, one function’s source instead of its file. Only clarifydoc_analyze and clarifydoc_diff write, and only to .clarifydoc/. Nothing leaves your machine — every network request any part can make.
OTHER HOSTS