Skip to main content
Glama

bx_dictionary_validate

Read-onlyIdempotent

Validate a complete UTF-8 JSON dictionary without saving to return field errors, ambiguity warnings, and a content SHA-256 hash for import.

Instructions

校验完整JSON字典,返回字段错误、歧义提示和导入摘要;不保存。 / Validate a complete UTF-8 JSON dictionary document without saving. Returns field errors, ambiguity warnings and content sha256 for import. No model call.

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": {
      "document": "<document>"
    },
    "name": "bx_dictionary_validate"
  }
}

Input Schema

NameRequiredDescriptionDefault
documentYes

Output Schema

NameRequiredDescriptionDefault
dataYes
kindYes
productYes
api_versionYes
business_decisionYes
execution_authorizationYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.4.0-rc.9-linux.1

TDQS

A4/5.0
Behavior4/5

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

Annotations already cover read-only, idempotent, closed-world and non-destructive behavior. The description adds genuinely new context: nothing is persisted, no model call is made (so it is deterministic and cheap), and ambiguity warnings plus a content sha256 are produced, which tells the agent what the response contains before it commits to an import.

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 short sentences per language, front-loaded with the verb and resource, then the side-effect disclaimer, then the return payload. Nothing is repeated wastefully and the bilingual duplication serves a clear purpose.

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?

With an output schema present, the description needn't detail return values, and annotations already cover safety. For a one-parameter, non-mutating validation tool the description supplies the essential facts (no persistence, no model call); only the relationship to bx_dictionary_import and document structure expectations remain implicit.

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 coverage is 0% for the single `document` parameter, so the description carries the burden. It does add meaningful constraints — the value is a complete UTF-8 JSON dictionary document — but says nothing about structure expectations, size limits, or what makes a document 'complete', leaving those to the schema's maxLength and type alone.

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 pairs a specific verb (validate) with a specific resource (a complete UTF-8 JSON dictionary document) and immediately contrasts with the saving operation implied by 'without saving' / '不保存'. It does not explicitly name the sibling bx_dictionary_format or bx_dictionary_import, so the boundary with those tools is only inferred from 'for import' rather than stated.

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 phrase 'without saving' and 'sha256 for import' clearly frame this as a dry-run check before an import step, giving the agent a usable context. There are no explicit exclusions or named alternatives, so the agent must infer that a successful validation precedes bx_dictionary_import.

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