Skip to main content
Glama

Items Validate

items_validate
Read-only

Validate an items.json registry by checking schema stamp, item record shape, unique part numbers, and reserved rev/lifecycle fields; returns ok, problems, schema, and count.

Instructions

Validate an items.json registry (the PLM item/document/file split, #140 C1). Checks the schema stamp ("ankusdrive.items/1"), each item record's shape, that part numbers are unique, and the held reserved rev/lifecycle fields. An item is the logical part (part_number + rev + lifecycle + metadata), distinct from its file artifact(s); part numbers are non-significant + sequential, with meaning in queryable metadata.

registry: path to the items.json sidecar.

Returns {ok, problems, schema, count} — 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": {
      "registry": "<registry>"
    },
    "name": "items_validate"
  }
}

Input Schema

NameRequiredDescriptionDefault
registryYes
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

A3.8/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 the safety profile is covered. The description adds useful behavioral detail: exactly what is validated and the return contract {ok, problems, schema, count}, including that ok is true iff problems is empty.

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?

The description is front-loaded with purpose and validation checks, then adds domain context about items versus file artifacts, and closes with the return contract. The item-definition sentence is somewhat extra for invocation but useful context; structure is otherwise efficient.

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?

There is no output schema, so the description must carry the return contract, and it does: {ok, problems, schema, count}. It also explains the validation criteria and the registry parameter sufficiently for a two-parameter read-only validator; workspace behavior is left to the schema.

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?

Schema description coverage is 50%; the required 'registry' parameter has no schema description, but the description explains it as the path to the items.json sidecar. The optional 'workspace' parameter is already documented in the schema, so the description does not need to repeat it, though it does not clarify how workspace affects the registry path.

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?

States a specific verb ('Validate') and resource ('items.json registry') and enumerates the checks it performs: schema stamp, item record shape, unique part numbers, and reserved rev/lifecycle fields. It does not explicitly differentiate itself from nearby validators such as items_check_manifest or validate_manifest, so it is clear but not fully sibling-aware.

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

Usage Guidelines3/5

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

The implied use case is clear: validate an items.json sidecar. However, it does not say when to choose this over items_check_manifest, items_resolve, or other validate_* tools, nor does it state when not to use it.

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