Skip to main content
Glama

Machine documentation

get_docs

One section of the machine documentation: quickstart, headers, signature, notice, errors, billing or limits. Omit section to get the whole document.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sectionNoWhich section to return. Omit for all of it.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / section / enum
      Previous value: -[
      -  "quickstart",
      -  "headers",
      -  "signature",
      -  "notice",
      -  "errors",
      -  "billing",
      -  "limits"
      -]New value: +[
      +  "quickstart",
      +  "verification",
      +  "headers",
      +  "signature",
      +  "notice",
      +  "errors",
      +  "billing",
      +  "limits"
      +]
  2. First observed

TDQS

A3.6/5.0
Behavior3/5

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

No annotations are provided, so the description carries the behavioral disclosure burden. It usefully discloses that omitting `section` returns the whole document rather than failing, but it does not mention output format, response structure, or any side effects; for a simple docs tool this is acceptable but minimal.

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?

A single sentence conveys the core behavior, enumerates relevant sections, and states the default behavior when the parameter is omitted. Every element earns its place with no filler.

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 single-parameter documentation retrieval tool, the description supplies enough information to invoke it correctly, including the omit-for-all behavior. It is slightly incomplete because it omits the 'verification' section from its list, though the schema fills that gap.

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 the baseline is 3: the input schema already documents the `section` parameter and its values. The description mostly repeats the enum list but omits the 'verification' option found in the schema, adding no real semantic value beyond what the schema provides.

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 clearly states the tool returns documentation content, specifically one named section or the whole document. It uses a specific verb and resource and is unlikely to be confused with the sibling action-oriented tools, though it does not explicitly name an alternative.

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

Usage Guidelines3/5

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

The description implies when to use this tool: whenever a section of the machine documentation is needed. It does not explicitly contrast it with informational siblings like get_pricing or get_service_status, leaving some inference to the agent.

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.