Skip to main content
Glama

JSONPad documentation

Get a JSONPad CLI command

get_cli_command
Read-onlyIdempotent

The usage, arguments and options of a jsonpad command line tool (@basementuniverse/jsonpad-cli) command, and whether it works offline. Find it by name ("rules test", "jsonpad sync-schema --dry-run") or by what it does.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoThe command, e.g. "sync-schema" or "jsonpad rules test"
queryNoWhat the command does, e.g. "export items to a file"

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
commandYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description adds one genuinely useful behavioral detail — that the result indicates whether the command works offline — but says nothing about error behavior or result shape.

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?

Single tight sentence that front-loads the payload (usage, arguments, options) before the lookup modes. Slightly dense with two example blocks, but no wasted wording.

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-value detail is not needed here, and the safety profile is covered by annotations. The description covers both lookup paths and the offline flag, leaving little an agent would need before calling it.

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 both parameters are already documented in the schema. The description's examples of name and query values reinforce the same information, adding little beyond what the schema provides; baseline 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?

States a specific verb (get) and resource (a JSONPad CLI command), enumerating what is returned: usage, arguments, options, and offline capability. It also names the concrete package (@basementuniverse/jsonpad-cli), which cleanly separates it from siblings like get_sdk_method and get_api_endpoint.

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 clear lookup modes — by name ("rules test", "jsonpad sync-schema --dry-run") or by what it does — which tells the agent how to invoke it. It stops short of saying when to prefer this over get_sdk_method or read_doc, so no explicit alternative routing.

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