Browse documentation

compute_rename_edits

[refactoring]

Previews TypeScript language-service rename edits for a symbol without applying them.

Try it locally in the TGlider playground

Parameters

NameTypeRequiredDescription
symbolKeystringYesStable symbol key returned by a prior symbol discovery tool.
newNamestringYesNew symbol name.
scopestringNoRename scope: 'same-project', 'direct-dependents', or 'transitive-dependents'. Default: "same-project"
includeCrossProjectbooleanNoDeprecated compatibility flag; prefer scope for cross-project rename planning. Default: false
allowPartialbooleanNoAllow a partial rename plan when some projects cannot be resolved safely. Default: false

Examples

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

Preview a safe rename

Arguments
{
  "symbolKey": "role=canonical|...",
  "newName": "AccountService"
}
Full MCP request
Full MCP request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "compute_rename_edits",
    "arguments": {
      "symbolKey": "role=canonical|...",
      "newName": "AccountService"
    }
  }
}

Response Notes

Returns a rename plan with affected files, occurrences, warnings, and cross-project impact.