Browse documentation

sync

[solution]

Applies pending index changes. Use full: true to rescan the repository.

Parameters

NameTypeRequiredDescription
responseDetailstringNocompact returns results and actionable state. full returns the original envelope with timing, revision, and display annotations. Default: "compact"
rootIdsjsonNoLoaded root IDs to synchronize. Omission selects all. Empty lists, duplicate IDs, and unknown IDs are rejected. Unreleased
fullbooleanNofalse: flush pending changes; true: full re-scan and rebuild. Default: false

Examples

Replace sample paths and symbol keys with values from your workspace.

Flush pending changes

Arguments
{}
Full MCP request
Full MCP request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "sync",
    "arguments": {}
  }
}

Force a full re-scan

Arguments
{
  "full": true
}
Full MCP request
Full MCP request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "sync",
    "arguments": {
      "full": true
    }
  }
}

Response Notes

Rarely needed because every query self-flushes via the freshness gate.

Returns flushed, rescanned, and the resulting index revision.

Unreleased multi-root support: rootIds selects roots; omission selects all. Synchronization retains the root set and settings. Full synchronization rescans selected membership without rereading configuration. Selected failures report partial results and retain other roots. Reload named roots to apply configuration changes.