Skip to main content
Glama

ECO Validate

eco_validate
Read-only

Validate an engineering change order before processing by checking its schema stamp, non-empty ID and affected items, a present disposition, and an effectivity with exactly one of date, serial, or revision.

Instructions

Validate an ECO (engineering change order) record (issue #142, C3) — the cheap front door. Checks the schema stamp, a non-empty id + affected item set, a present disposition, and an effectivity carrying exactly one of date|serial|revision.

eco: the ECO object.

Returns {ok, problems} — ok is True iff problems is empty.

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": {
      "eco": "<eco>"
    },
    "name": "eco_validate"
  }
}

Input Schema

NameRequiredDescriptionDefault
ecoYes
workspaceNoRun this call in this named workspace

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.5.7
    • addedInput schema / properties / workspace
      Added value: +{
      +  "default": "",
      +  "description": "Run this call in this named workspace",
      +  "title": "Workspace",
      +  "type": "string"
      +}
  2. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety is covered; the description adds real value by disclosing the exact validation rules and the non-throwing return contract {ok, problems}, which tells the agent this call reports rather than raises. It does not say what a 'schema stamp' is or whether malformed input throws instead of returning problems.

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?

Three short blocks, front-loaded with the purpose, then the parameter, then the return contract — easy to scan. The parenthetical "(issue #142, C3)" is internal tracker noise that consumes space without helping an agent decide or call correctly.

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

Completeness4/5

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

For a read-only validator with no output schema, the description supplies the return shape ({ok, problems}) and the full list of checks, which is enough to call it and interpret the result. It stops short of explaining how to resolve a reported problem or which sibling to call next after a failure.

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

Parameters4/5

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

The nested 'eco' object has no schema description at all (additionalProperties: true, only a title), so the description carries the burden and does so by naming the fields that must be present: id, affected items, disposition, effectivity. 'workspace' is documented in the schema itself. The remaining gap is that the expected shape/format of the schema stamp and effectivity values is not specified.

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?

States a specific verb (Validate) and resource (an ECO record) and immediately enumerates the concrete checks performed: schema stamp, non-empty id + affected item set, present disposition, effectivity with exactly one of date|serial|revision. This is clearly distinguishable from siblings like eco_create, baseline_verify, or lifecycle_apply_change.

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?

"The cheap front door" is a genuine usage signal — it tells the agent to run this lightweight check before committing to heavier ECO operations. However, no sibling is named explicitly (eco_create, lifecycle_apply_change) and there is no explicit statement of when-not-to-use or what to do with a failed result.

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

Deploy Server

Other Tools