Skip to main content
Glama

Machine documentation

get_docs
Read-onlyIdempotent

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

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_docs"
  }
}

Input 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?

Annotations already declare readOnlyHint, idempotentHint, non-destructive and closed-world, so the safety profile is fully covered. The description adds the useful fact that omitting the parameter returns the entire document, but says nothing about the size, format, or shape of the returned documentation text.

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 short sentences with zero filler: the resource is front-loaded and the omission behavior follows immediately. Nothing is repeated beyond necessity.

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-optional-enum, read-only tool with full schema coverage and no output schema, the description covers what the tool returns (a documentation section or the whole document) adequately. The only gap is any hint about the returned content's format or length.

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% and the single parameter is a declared enum, so the schema does the heavy lifting. The description re-lists most enum values, which adds nothing, and notably omits 'verification' from its list, mildly under-representing the actual enum.

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?

States a specific resource (machine documentation) and scope (one section, or the whole document if section is omitted). It is clearly distinct from the sibling tools, which are all task/destination mutations or status/pricing lookups, though it never explicitly contrasts itself with the overlapping get_pricing/get_service_status tools.

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 only usage guidance is 'Omit `section` to get the whole document', which is mechanical invocation advice rather than when-to-use advice. It does not say when to consult the docs versus get_pricing (billing section) or get_service_status, which are plausible alternatives for the same information.

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.