Skip to main content
Glama

Compare Files

compare_files
Read-onlyIdempotent

Compare two text files to detect differences and get a diff summary. Use it to check whether file contents match or have changed.

Instructions

Compare two text files and report whether they differ, with a diff summary.

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": {
      "path1": "<path1>",
      "path2": "<path2>"
    },
    "name": "compare_files"
  }
}

Input Schema

NameRequiredDescriptionDefault
path1YesFirst file path
path2YesSecond file path

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.1

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=false, so the safety and purity profile is fully covered externally. The description contributes only the fact that a 'diff summary' is returned, without saying how large or detailed it is, whether it truncates, or how missing/unreadable files are handled.

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

Conciseness4/5

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

A single front-loaded sentence with no filler; the primary action and result come first. It is efficient, though brevity here edges toward under-specification rather than crispness.

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?

For a simple two-parameter read tool with no output schema, the description covers the core action and roughly what is returned, and annotations handle safety. It falls short on the shape of the 'diff summary' and on failure behavior, which an agent would want before invoking it.

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%, with both path1 and path2 documented, so the baseline is 3. The description adds no meaning beyond the schema — it does not clarify whether paths are absolute or relative, or whether the same path is permitted.

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

Purpose4/5

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

The description names a specific verb and resource ('Compare two text files') and states the outcome ('report whether they differ, with a diff summary'), which is far more informative than the title alone. It does not explicitly contrast itself with nearby siblings such as search_files or get_file_info, so differentiation is left to inference.

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

Usage Guidelines2/5

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

There is no when-to-use guidance, no statement of prerequisites, and no alternatives named. The phrase 'text files' implicitly narrows scope (not binary, not directories), but the agent is given no guidance on when this is preferable to other inspection tools or what to do if a path is invalid.

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