xmind-mcp / rules
Cursor rule9 starsChanged 21 days agoMITView on GitHub
After any structural change, review and update project documentation
Where files are headingNew Cursor rule files have more rules about planning and tracking tasks, and fewer about code style.
Of the Cursor rule files we read, the 4,183 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository5 other files it gives its agents.
- AGENTS.mdAGENTS.md
- commit-messageSkill
- review-planSkill
- verify-changesSkill
- xmind-mcp-smoke-testSkill
The file
We split this keep-docs-current.mdc into the rules it gives an agent
2 rules. About 0 are common, 2 are distinctive, and 0 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈2
Distinctive · estimate
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 8
If your change falls into any category in the table below, update the corresponding documentation before finishing.
- Distinctive: line 23
If none of the above changes were made, no doc update is needed.
≈ “Common” is an estimate: at least 1 in 5 of the 6,668 Cursor rule files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
--- description: After any structural change, review and update project documentation alwaysApply: true --- # Keep Documentation Current If your change falls into any category in the table below, update the corresponding documentation before finishing. ## What triggers a doc update | Change made | What to review/update | |---|---| | New file added or removed | `Project Structure` tree in `AGENTS.md` | | New handler helper added to `handler.go` | Appropriate subsection in `AGENTS.md` (traversal/lookup table for tree helpers; Text response helper for `textResult` / `jsonResult`) | | New tool registered, renamed, or removed | Tier tables and tool count in `README.md`; steps, coverage, and tool count in the `xmind-mcp-smoke-test` skill; tool leaves, tier notes, and counts in `cmd/gen-example/main.go` (then `make gen-example` and retake the README PNG); `serverInstructions` if the workflow changes; Conventions section in `AGENTS.md` if a new pattern is introduced | | New struct field or codec field-table entry | Schema Critical Notes in `AGENTS.md` | | New convention established | `Conventions` section in `AGENTS.md` | | New `.cursor/rules/` or `.agents/skills/` file | Reflect in `AGENTS.md` if it affects agent behavior | ## Rule If none of the above changes were made, no doc update is needed. Do not make cosmetic edits to demonstrate compliance — only update docs when something has genuinely changed.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.