Skip to main content
Glama

Redact a named JSON field

bpj_json_redact_field
Read-onlyIdempotent

Replace values of every matching object key with a redaction marker.

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>",
      "field": "<field>"
    },
    "name": "bpj_json_redact_field"
  }
}

Input Schema

NameRequiredDescriptionDefault
fieldYes
documentYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

C2.7/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true and destructiveHint=false, so the safety and repeatability profile is covered; the description adds no further behavior beyond that. It does not state what the redaction marker actually is, whether nested objects and objects inside arrays are traversed, or whether matching is case-sensitive — all of which materially change the result. The description's 'Replace values' wording sits uneasily next to readOnlyHint, but since the replacement happens only inside the supplied document string and no stored data is mutated, this is ambiguity rather than a true contradiction.

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?

A single front-loaded sentence with no filler and no repetition of the title. Its brevity is efficient, though it shades into under-specification given the undocumented behaviors noted above.

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

Completeness2/5

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

The tool is simple (two required string params) and annotations plus schema cover the mechanical surface, but with no output schema the description should say what comes back — the transformed document string versus a redaction count, for example. Combined with the unspecified marker text and matching scope, an agent cannot predict the output from the definition alone.

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

Parameters2/5

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

Schema description coverage is 0% for both parameters, so the description must carry the burden and largely fails: 'field' is only obliquely referenced as 'matching object key', with no statement that it is a key name matched at any depth. The 'document' parameter is never mentioned at all — its requirement to be a JSON string and its 6000-character limit appear only in the raw schema with no semantic framing.

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 gives a specific verb and resource ('Replace values of every matching object key'), which is clearer than the title's vague 'a named JSON field' because 'every matching key' signals all occurrences, not just the first. It does not differentiate itself from nearby siblings like bpj_json_remove_null_members or bpj_json_retain_root_keys, which also transform key/value structure, so sibling routing is left to inference.

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

Usage Guidelines2/5

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

There is no guidance on when to choose this tool over the many other JSON-reshaping siblings, and no stated preconditions (e.g., that the input must be a valid JSON object). An agent must infer usage entirely from the verb 'redact', with no exclusion cases or named alternative.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.