Incrementally sync the vault index to keep AI agent memory current with markdown files. Provide a project key when the IDE has multiple workspace roots.
Incremental vault index sync (same as CLI rms-memory sync). Prefer an explicit project when the IDE is multi-root.
| Name | Required | Description | Default |
|---|---|---|---|
| project | No | Registered project key, used when the MCP client did not provide a workspace root. |
Changes observed during successful MCP inspections.
v1.2.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are present, so the description must disclose behavior; it only says 'incremental' and CLI equivalence, but doesn't state side effects, whether it mutates the index, required environment, or failure modes.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, front-loaded purpose, no filler; the CLI parenthetical gives a concrete anchor without bloating.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a single-optional-param tool the basics are covered, but absent annotations and output schema leave behavior (index mutation, incremental semantics) unexplained. It is minimally adequate.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% and already explains the project fallback. The description adds a practical 'prefer project in multi-root' heuristic, which is useful but minimal.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific action (incremental sync) and resource (vault index), and the CLI equivalence helps identify it. Does not name a sibling, but 'incremental' distinguishes it from a full reindex.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Only guidance is a condition for setting the `project` parameter. It says nothing about when to choose sync over sibling tools like rms_reindex or rms_prune.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.