Skip to main content
Glama

Get Documentation

get_documentation
Read-onlyIdempotent

Read a chapter of the Dregs manual as text. Call without a topic to list the chapters with a one-line summary each; call with a topic to get that chapter. Read SCORING before interpreting scores, ESCALATIONS or BADGES before creating or changing rules, CHANNELS or WEBHOOKS before debugging deliveries, and SERVER_SDKS before writing backend event tracking or score lookups, so you use the official client for the language rather than hand-rolling HTTP.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
topicNoThe chapter to read; omit to list them.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / topic / enum
      Previous value: -[
      -  "HOW_DREGS_WORKS",
      -  "GETTING_STARTED",
      -  "TRACKING",
      -  "IDENTITIES",
      -  "DEVICES",
      -  "SCORING",
      -  "EVENTS",
      -  "DASHBOARD",
      -  "ESCALATIONS",
      -  "BADGES",
      -  "CHANNELS",
      -  "WEBHOOKS",
      -  "DATASETS",
      -  "TEAM",
      -  "SERVER_SDKS",
      -  "API",
      -  "AI_AGENTS"
      -]New value: +[
      +  "HOW_DREGS_WORKS",
      +  "GETTING_STARTED",
      +  "TRACKING",
      +  "IDENTITIES",
      +  "GROUPS",
      +  "DEVICES",
      +  "SCORING",
      +  "EVENTS",
      +  "DASHBOARD",
      +  "ESCALATIONS",
      +  "BADGES",
      +  "CHANNELS",
      +  "WEBHOOKS",
      +  "DATASETS",
      +  "TEAM",
      +  "SERVER_SDKS",
      +  "API",
      +  "AI_AGENTS"
      +]
  2. Changed1 schema field changed
    • changedInput schema / properties / topic / enum
      Previous value: -[
      -  "HOW_DREGS_WORKS",
      -  "GETTING_STARTED",
      -  "TRACKING",
      -  "IDENTITIES",
      -  "DEVICES",
      -  "SCORING",
      -  "EVENTS",
      -  "DASHBOARD",
      -  "ESCALATIONS",
      -  "BADGES",
      -  "CHANNELS",
      -  "WEBHOOKS",
      -  "DATASETS",
      -  "TEAM",
      -  "API",
      -  "AI_AGENTS"
      -]New value: +[
      +  "HOW_DREGS_WORKS",
      +  "GETTING_STARTED",
      +  "TRACKING",
      +  "IDENTITIES",
      +  "DEVICES",
      +  "SCORING",
      +  "EVENTS",
      +  "DASHBOARD",
      +  "ESCALATIONS",
      +  "BADGES",
      +  "CHANNELS",
      +  "WEBHOOKS",
      +  "DATASETS",
      +  "TEAM",
      +  "SERVER_SDKS",
      +  "API",
      +  "AI_AGENTS"
      +]
  3. First observed

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so safety is covered. The description adds genuinely new context: the return format is 'text' and that omitting the topic yields a listing with one-line summaries. It does not discuss size limits or pagination, keeping it just short of a 5.

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?

Front-loaded with the core action and the two modes before the longer chapter-routing guidance. Every sentence carries information, though the final routing sentence is dense and could be trimmed slightly.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

No output schema exists, so the description compensates by describing both return shapes (a summarized list or a text chapter) and guiding the agent to the right chapter. Nothing needed to invoke it correctly is missing.

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 coverage is 100% and the enum is fully enumerated, so the schema does the heavy lifting. The description still adds value beyond it by spelling out the omit-to-list vs provide-to-read semantics and naming which chapters matter for which tasks.

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?

States a specific verb and resource ('Read a chapter of the Dregs manual as text') and clearly describes the dual behavior. No sibling tool overlaps, and an agent can immediately tell this is the documentation access point.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly distinguishes the two invocation modes ('call without a topic to list... call with a topic to get that chapter') and gives concrete when-to-use guidance mapping each chapter (SCORING, ESCALATIONS, BADGES, CHANNELS, WEBHOOKS, SERVER_SDKS) to the task that requires reading it.

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.