Skip to main content
Glama
TheoryofShadows

@mcpx-digital/env-check

redact_env_report

Generate a paste-safe inventory of environment variable keys from a local .env file, with every value redacted for secure sharing in tickets or documentation. Secrets are never echoed.

Instructions

Produce a paste-safe inventory of keys in an env file with all values redacted. Local .env files only. Reports redact values and never echo secrets.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
envPathNoPath to env file (default .env).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.8/5.0
Behavior4/5

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

With no annotations, the description carries the behavioral burden. It explicitly states that values are redacted and that it 'never echo secrets', which is a valuable safety guarantee. However, it does not describe the exact report format or side effects, though the name implies a read-only operation.

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?

Two sentences with the main purpose front-loaded. There is some redundancy between 'all values redacted' and 'Reports redact values', but overall the description is compact and efficient.

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

Completeness3/5

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

The tool has one optional parameter and no output schema, and the description explains the general behavior and safety guarantees. However, it does not specify the output format, error handling, or conditions under which the tool might fail, leaving some gaps for an agent to infer.

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 100%, and envPath is documented in the schema. The description adds only the 'Local .env files only' constraint, which is a minor semantic addition rather than a full description of the parameter's meaning.

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 uses a specific verb ('Produce') and a distinct artifact ('paste-safe inventory of keys in an env file with all values redacted'). It clearly differentiates from siblings 'compare_env_files' and 'detect_empty_required', which serve other purposes.

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

Usage Guidelines3/5

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

It gives a usage constraint with 'Local .env files only', but does not explicitly explain when to use this tool over alternatives or mention the sibling tools. No when-to-use or when-not-to-use guidance is provided.

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