Skip to main content
Glama

readme

Read first, before any other tool. Covers working with the user, how a flow runs, expressions ({ text }, {{...}} references), ways to start a flow, the blocks, groups and loops, extensions and connections, the build workflow, and what is not supported.

Input Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the full disclosure burden. It does useful expectation-setting by listing the topic areas the readme covers, including 'what is not supported', but it never states that the call is a read-only, side-effect-free reference fetch, nor anything about output format, length, or token cost of the returned documentation. Adequate but with clear gaps for a no-annotation tool.

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?

The imperative prerequisite is front-loaded in four words, followed by a single scannable content index. The second sentence is a long comma-list that runs on somewhat, but every item is a distinct documentation topic and none is filler padding.

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 two-sentence, zero-parameter documentation tool with no output schema, the definition gives an agent everything needed to decide to call it first and what it will learn. The remaining omission is the shape and size of the returned text, which is minor given the simplicity of the tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The tool takes zero parameters and the schema has no properties, so there is no parameter meaning to convey and nothing the description could add. The content list in the description is the only relevant scoping information and it is present.

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 verb+resource is clear in effect: read the reference documentation, and the second sentence enumerates exactly which topics that documentation covers (flows, expressions, blocks, extensions, build workflow, unsupported features). It is distinguishable from every sibling, all of which act on concrete flows/blocks rather than returning documentation. It stops short of a single explicit statement like 'returns the platform reference guide', so the actor/return object is inferred from the name.

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?

'Read first, before any other tool' is an explicit and unusually strong ordering directive, which is the key usage decision for a docs tool. There is no when-not clause and no alternative named, but for a zero-parameter reference read that is largely unnecessary since no sibling overlaps its function.

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