Skip to main content
Glama

mask_json

Read-only

Show the shape of large JSON documents by keeping key paths and shortening long arrays and strings. Inspect big API responses, then expand omitted details with a path.

Instructions

Show the shape of a large JSON document: every key path stays, long arrays and strings are shortened. Use it to see what a big API response contains; fetch details with expand and a path such as $.items[3].

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "mask_json"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathNoFile to read, inside the server's root folder. Preferred way to pass input.
textNoThe text itself. Only for small inputs: large text costs tokens to send.
commandNoA command to run and trim (no shell). Only works if started with --allow-run.
max_depthNoNesting levels shown before summarising.
max_itemsNoArray items kept.
max_stringNoCharacters kept per long string.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already cover safety (readOnlyHint=true, destructiveHint=false, openWorldHint=false), and the description adds meaningful behavioral context about how structure is preserved while arrays and strings are truncated. It does not discuss defaults for the truncation limits, though those are documented per-parameter in the schema.

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 sentences, front-loaded with the core behavior and followed by the practical routing instruction. No filler or repetition.

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 full annotation coverage, a complete input schema, and an output schema, the description only needs to explain purpose and routing, which it does. A brief note on the input source options (path, text, or command) would make it fully self-sufficient.

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 100%, so parameter meaning is already fully carried by the schema. The description adds no parameter-level detail beyond mentioning a path example that actually belongs to the expand sibling, so the baseline of 3 applies.

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?

The description states a specific verb and resource ('Show the shape of a large JSON document') and immediately defines the transformation rule ('every key path stays, long arrays and strings are shortened'), which separates it from a full-content retrieval tool.

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?

It gives a clear when-to-use ('to see what a big API response contains') and names the alternative tool plus the exact argument form ('fetch details with expand and a path such as $.items[3]'). It stops short of explicit exclusions, such as not using it for small inputs or mutating cases, but the routing guidance is solid.

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