ts-mcp-server

Overview Schema Source Related Servers Discussions Admin

Format

format

DestructiveIdempotent

Apply consistent indentation, spacing, and line breaks to TypeScript code. Specify a range for targeted formatting or use the full file for complete formatting.

Instructions

Format a range of code according to TypeScript's formatting rules. Applies consistent indentation, spacing, and line breaks. Specify a range or use the full file length to format the entire file.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "file": "<file>",
      "line": "<line>",
      "offset": "<offset>",
      "endLine": "<endLine>",
      "endOffset": "<endOffset>",
      "preview": "<preview>"
    },
    "name": "format"
  }
}

Input Schema

Name	Required	Description
`file`	Yes	File path (absolute or relative to cwd)
`line`	Yes	Start line (1-based)
`offset`	Yes	Start offset (1-based)
`endLine`	Yes	End line (1-based)
`options`	No	Formatting options
`preview`	Yes	If true, return edits without applying
`endOffset`	Yes	End offset (1-based)

Schema Changelog

Changes observed during successful MCP inspections.

First observedv1.1.1Jul 12, 2026

TDQS

A4.1/5.0

Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare destructiveHint=true and idempotentHint=true. Description adds context about applying consistent indentation/spacing/line breaks and preview mode. No contradiction with annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two concise sentences front-loading purpose and usage. No redundant information; every sentence adds value.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (7 params, nested options, destructive behavior), description is adequate but not exhaustive. Lacks details on return value (no output schema) and effects beyond format, but schema and annotations cover much.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so parameters are already documented. Description adds some context (range vs full file, preview behavior) but does not significantly enhance understanding beyond schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb 'Format' and resource 'a range of code according to TypeScript's formatting rules.' It specifies the scope (range or full file) and distinguishes from sibling tools like 'organizeImports' or 'rename' by focusing on formatting behavior.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Provides clear usage hint: specify a range or use full file length. Does not explicitly mention when not to use or alternatives, but the sibling list includes no other formatting tool, so omission is acceptable.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.