Skip to main content
Glama

redaction

Put the real details back

restore
Read-onlyIdempotent

Reverse a redaction using the map it returned. Use this on a model's reply so the reader sees what they actually wrote rather than the stand-ins.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
mapYesThe map returned by redact.
textYesUsually a model's reply, containing stand-ins.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
textYesThe text with the real values put back.
restoredYesHow many values were replaced.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

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, idempotentHint=true). The description adds context about the map source and the transformation effect ('sees what they actually wrote'), which is useful beyond the annotations. There is no contradiction; 'reverse' implies a pure transformation consistent with readOnlyHint.

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 action and then the purpose. Zero wasted words. The description is optimally sized for the tool's simplicity.

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?

The tool is simple with only two parameters and has an output schema (not shown but present). The description covers purpose, usage, and the map source. It does not mention error cases (e.g., missing map keys) but these are not critical given the tool's scope and the annotations. It is sufficiently complete for an agent to invoke it correctly.

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 the schema already documents both parameters ('The map returned by redact' and 'Usually a model's reply, containing stand-ins'). The description adds minimal new meaning by linking the map to redact's output and the text to a model reply, but it does not go beyond the schema baseline. A 3 is appropriate.

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 clearly states the action: 'Reverse a redaction using the map it returned.' It names the specific resource (redaction) and the method (reverse), and the sibling tool 'redact' makes the inverse relationship obvious. This unambiguously distinguishes it from redact.

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 provides explicit usage context: 'Use this on a model's reply so the reader sees what they actually wrote rather than the stand-ins.' This tells the agent when to apply it, and it implicitly contrasts with redact by describing the opposite operation. It lacks an explicit 'when not to use' but the context is sufficient.

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.

Resources