Skip to main content
Glama

read_block

Read-onlyIdempotent

List a survey's blocks in order (survey_id), or read one block (block_id) with its kind, question order and randomization, loop, and end-screen settings. include trash lists recoverable deleted blocks.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "read_block"
  }
}

Input Schema

NameRequiredDescriptionDefault
includeNoWhen survey_id is set, include recoverable trashed blocks in the list.
block_idNoBlock UUID
survey_idNoList all blocks in this survey when block_id is omitted

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and closed-world scope, so the safety profile is covered. The description adds genuine behavioral context beyond that: blocks are returned in order, and trashed blocks are recoverable and only surface via include=trash.

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, front-loaded with the primary listing behavior before the single-read variant. The trailing clause 'include trash lists recoverable deleted blocks' is slightly clipped and reads like a fragment, 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 present, the description needn't enumerate returned fields, and annotations cover the safety profile, so the remaining burden is small. The one unaddressed case is the behavior when both survey_id and block_id are omitted, which matters given all parameters are optional.

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%, so all three parameters are already documented in the schema, including the trash enum semantics. The description restates the survey_id/block_id mode split and the trash behavior without adding syntax or format detail, which is the expected baseline when the schema does the work.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource ('List a survey's blocks') and clearly splits the tool into two modes tied to survey_id (list) and block_id (single read). It is distinguishable from siblings like read_survey and read_question, though it does not name them explicitly.

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 gives explicit mode-selection rules: pass survey_id to list, pass block_id to read one, and add include=trash only when listing. The gap is the case where neither id is supplied (0 required parameters), where the description does not state the outcome or that a parameter is required.

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