Skip to main content
Glama

Read BrewPage guide

get_guide
Read-only

Reference texts: page-data (meant to be read before writing a page that saves visitor input), custom-domain (steps, DNS records, statuses, fixes).

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "topic": "<topic>"
    },
    "name": "get_guide"
  }
}

Input Schema

NameRequiredDescriptionDefault
topicYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • removedInput schema / $schema
      Removed value: -"https://json-schema.org/draft/2020-12/schema"
    • removedInput schema / properties / topic / description
      Removed value: -"Guide topic"
  2. Changed1 schema field changed
    • changedInput schema / properties / topic / enum
      Previous value: -[
      -  "page-data"
      -]New value: +[
      +  "page-data",
      +  "custom-domain"
      +]
  3. Added

TDQS

A3.9/5.0
Behavior3/5

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

The readOnlyHint annotation already establishes that this is a safe read operation. The description adds that the tool returns reference texts and what each topic covers, but it does not describe return format, length, or other behavioral details beyond the annotations.

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 compact sentence with no wasted wording. It front-loads the resource type and then maps each topic to its purpose.

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 simple one-parameter read-only reference tool, the description covers both possible topics and their intended use. It could be slightly more explicit that the tool returns the reference text, but the title and description together make this sufficiently clear.

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

Parameters4/5

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

Schema description coverage is 0%, so the description must explain the single enum parameter. It does so by defining both `page-data` and `custom-domain` with meaningful context, adding substantial meaning beyond the bare enum values.

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 identifies the resource as reference texts and names the two available topics, so an agent can tell this is a guide-reading tool. It lacks an explicit verb like "returns" or "reads," but the topic list makes the purpose clear enough.

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 a clear usage condition for `page-data`: read before writing a page that saves visitor input. For `custom-domain`, it lists the covered material (steps, DNS records, statuses, fixes), which implies troubleshooting/setup use, though it does not name alternatives or exclusions.

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.