format_document

[codefix]

Formats a TypeScript or JavaScript document with TypeScript language-service edits.

Before you use this tool

Previews edits by default. Application changes live documents. Use write_file to save the result to disk.

Try it locally in the TGlider playground

Parameters

Name	Type	Required	Description
filePath	string	Yes	Workspace-relative or absolute file path.
applyChanges	boolean	No	Apply formatting edits to live workspace state instead of returning preview only. Default: `false`
includeDiff	boolean	No	Include a unified diff in the response. Default: `true`
maxDiffChars	number	No	Maximum diff characters to return before truncating. Default: `50000`
indentSize	number	No	Indent width to use for formatting. Defaults to the document indentation style.
tabSize	number	No	Tab width to use for formatting. Defaults to the document indentation style.
convertTabsToSpaces	boolean	No	Use spaces instead of tabs for indentation. Defaults to the document indentation style.
semicolons	string	No	Semicolon preference: 'ignore', 'insert', or 'remove'. Defaults to preserving existing semicolon style. Default: `"ignore"`

Examples

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

Preview formatting edits

Arguments 
{
  "filePath": "src/app.ts"
}

Full MCP request

Full MCP request 
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "format_document",
    "arguments": {
      "filePath": "src/app.ts"
    }
  }
}

Response Notes

Returns formatting edits, preview diff metadata, live-document version state, and whether changes were applied.