Skip to main content
Glama

bx_dictionary_import

Idempotent

Import a validated L2/L3 dictionary using its SHA-256 checksum, rejecting conflicting same ID/version content while leaving tasks and existing dictionaries unchanged.

Instructions

按校验摘要导入自定义字典,同版本不同内容拒绝覆盖;不修改任务或旧字典。 / Import a validated L2/L3 dictionary into this installation data directory. Supply the sha256 from validate. Idempotent by content; conflicting same ID/version is rejected. Never changes tasks or old dictionaries.

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>",
      "sha256": "<sha256>"
    },
    "name": "bx_dictionary_import"
  }
}

Input Schema

NameRequiredDescriptionDefault
sha256Yes
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.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, idempotentHint=true and destructiveHint=false, so the safety profile is covered. The description adds value beyond that: idempotency is by content, a same-ID/version content mismatch is a hard rejection, and the blast radius is bounded ('never changes tasks or old dictionaries'). It does not mention permissions or whether a rejected import can be retried after cleanup.

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?

Each language block is two tight sentences, front-loaded with the action and followed by the constraint and the non-effects. The only waste is the full Chinese/English duplication, which repeats the same facts rather than adding any.

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?

An output schema exists, so return values need not be described, and the annotations already cover the safety and idempotency profile. What an agent still might want – what constitutes an L2 vs L3 dictionary and the document's expected format – is missing, but nothing essential to invoking it correctly is absent.

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 0%, so the description carries the burden. It does explain the provenance of sha256 (it comes from the validate step, tying it to the sibling tool), but gives no detail on the 'document' parameter beyond 'a validated L2/L3 dictionary' – its serialization, what L2 vs L3 means, or the 256 KiB limit are left entirely to the schema.

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 (import) and resource (custom L2/L3 dictionary) with explicit scope: into this installation data directory. It also distinguishes itself from the neighboring validation step by requiring 'the sha256 from validate', so an agent can tell this apart from bx_dictionary_validate or bx_dictionary_lookup without opening any schema.

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?

Gives a clear precondition ('Supply the sha256 from validate') and the exact failure condition to anticipate ('conflicting same ID/version is rejected'), which amounts to usable when-to-use guidance. It stops short of naming an explicit alternative tool or saying when not to import at all, so it is clear context rather than full routing guidance.

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