Skip to main content
Glama

pad_read

Retrieve a pad's content, revision, and metadata by providing its ID or name.

Instructions

Read a pad's content, revision, and metadata by pad_id or name.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNo
pad_idNo
project_idNoDifferent project override. Use ONLY when the user explicitly asks for another project by name; otherwise stay in the current scope, even when results are empty.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A3.7/5.0
Behavior3/5

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

With no annotations, the description carries the full burden of behavioral disclosure. It does communicate the read-only nature and the returned data categories, but it omits important behaviors such as what happens when no pad is found, whether pad_id or name is preferred if both are supplied, and any access constraints.

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?

The description is a single sentence with no filler. The action, object, result surface, and lookup mechanism are all front-loaded and every word contributes value.

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?

For a read operation the description is fairly complete: it identifies the lookup keys and the returned information categories. However, with no output schema and no annotations, the absence of a stated requirement to provide at least one of pad_id or name, and the lack of no-match behavior, leaves some invocation ambiguity.

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 low (33%), so the description must compensate. It adds meaning by presenting pad_id and name as alternative identifier keys, but it does not explicitly state that at least one is required or define precedence if both are passed. project_id is already described in the schema.

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 ('Read') with a clear resource ('a pad's content, revision, and metadata') and identifies the lookup modes ('by pad_id or name'). This clearly distinguishes pad_read from mutation siblings like pad_write, pad_append, pad_edit, and pad_delete.

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?

The read action implies when to use the tool, but there is no explicit guidance about when not to use it or which siblings are alternatives. It does not state exclusions or provide routing cues beyond the verb itself.

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