Skip to main content
Glama

format_check

Read-onlyIdempotent

Check if an MQL4/MQL5 source file adheres to clang-format standards before compilation. Specify style rules to validate formatting and identify non-compliant code for correction.

Instructions

DEPRECATED (removed in 0.6.0): use format_mql(source) (dry run by default).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
styleNoclang-format style string.
sourceYesAbsolute Windows path to the .mq4/.mq5/.mqh source file.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv0.5.0
    • addedInput schema / properties / source / description
      Added value: +"Absolute Windows path to the .mq4/.mq5/.mqh source file."
    • addedInput schema / properties / style / description
      Added value: +"clang-format style string."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "additionalProperties": true,
      +  "title": "format_checkDictOutput",
      +  "type": "object"
      +}
  2. First observedv0.4.1

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already disclose read-only, idempotent, and non-destructive behavior. The description adds critical behavioral context beyond those annotations: the tool is deprecated, removed in 0.6.0, and superseded by a tool that dry-runs by default. No contradiction exists.

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?

A single sentence front-loads the deprecation status and immediately provides an actionable replacement. Every word earns its place and the format is highly scannable.

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

Completeness5/5

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

For a deprecated tool, the description is complete: it states deprecation, removal version, replacement, and replacement behavior. Combined with the annotations and documented parameters, an agent has everything needed to avoid misuse.

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 in the schema. The description adds no extra meaning about source or style, but none is required given the high schema coverage and the fact that the tool is deprecated.

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

Purpose2/5

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

The description never states what format_check actually does; it only announces deprecation and points to format_mql. The intended purpose must be inferred from the tool name, which is not sufficient for a clear definition.

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

Usage Guidelines5/5

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

The description explicitly tells the agent not to use this tool, names the exact replacement (format_mql), gives the invocation pattern (format_mql(source)), and notes the default dry-run behavior. This is ideal routing guidance for a deprecated tool.

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