Skip to main content
Glama

JSONPad documentation

Get a JSONPad SDK method

get_sdk_method
Read-onlyIdempotent

The signature, description and example of a method in the JavaScript SDK (@basementuniverse/jsonpad-sdk) or the realtime SDK, and the REST endpoint it calls. Find it by name ("restoreItem") or by what it does.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoThe method name, e.g. restoreItem
queryNoWhat the method does, e.g. "wait for an index to build"
packageNoOnly one package

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
methodYes

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 this a read-only, idempotent, non-destructive, closed-world lookup, so the safety profile is fully covered. The description's only behavioral addition is the list of returned content, which is largely redundant given an output schema exists, and it says nothing about ambiguity, multiple matches, or whether the SDK docs must be indexed.

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 compact sentences with no filler; the returned artifacts are front-loaded and the lookup instruction follows. Slightly awkward phrasing in the first clause, but nothing is wasted.

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 an output schema and complete annotations, the description only needs to establish what is retrieved and how to search. It does both adequately, though edge behavior for fuzzy/ambiguous queries is left unaddressed.

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 baseline is 3. The description restates the name-vs-query distinction already present in the schema and adds no format, matching, or precedence rules (e.g. what happens if both name and query are supplied, or how package narrows results).

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 names a specific resource (a method in the JavaScript SDK @basementuniverse/jsonpad-sdk or the realtime SDK) and enumerates exactly what is returned: signature, description, example, and the REST endpoint it calls. It is implicitly distinguishable from siblings like get_api_endpoint, get_cli_command and read_doc, which target different artifact types.

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 tells the agent the two lookup modes: "Find it by name (\"restoreItem\") or by what it does." That maps directly onto the name/query parameters and gives clear usage context. It stops short of naming an alternative sibling or stating when not to use this tool, so it falls short of a 5.

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