Skip to main content
Glama

Read reference

read_reference
Read-only

Read the exact grammar for pipeline blocks, conditions, or escalation path and team escalation policy documents. Read the relevant topic before writing one: unknown fields are refused and ids must be UUIDs.

Input Schema

NameRequiredDescriptionDefault
topicYesOne of: pipeline_blocks (block envelope and each type's config), conditions (the condition tree branches, delegates and request conditions use: fields, operators, values), escalation_paths (path and team escalation policy documents: nodes, targets, timing, working hours, repeat).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so safety is covered. The description adds valuable behavioral context beyond annotations by noting "unknown fields are refused and ids must be UUIDs," which tells the agent about validation rules that matter when writing pipeline content. It does not describe the return format, but the extra enforcement detail is meaningful.

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?

Two sentences, no filler, and the purpose is front-loaded before the usage instruction. Every sentence earns its place by stating what to read and why.

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?

For a single-parameter, read-only reference tool with annotations covering safety, the description is nearly complete. It names the topics and validation constraints, though it could say more about what the returned reference material looks like.

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%, and the schema already enumerates the three possible topic values with detailed explanations. The description mentions the same topics but does not add syntax or selection guidance beyond what the schema provides, so 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?

The description states a specific verb and resource: "Read the exact grammar for pipeline blocks, conditions, or escalation path and team escalation policy documents." It clearly identifies this as a reference-reading tool rather than a CRUD or inspection sibling, and the topic list mirrors the parameter's domain.

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 timing: "Read the relevant topic before writing one." That tells the agent when this tool is needed. It does not name specific alternative tools or when not to use it, but the context is clear enough for a reference tool.

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.