Skip to main content
Glama

get_documentation

Read-only

Retrieve the full text of a specific documentation entry by its id (obtained from search_documentation results — ids look like 'user_guide:360038959391' or 'legal:terms'). Returns title, URL, source, and the body as plain text. Some user-guide articles have screenshots included as Markdown-formatted images. The Cloud Script API TypeScript reference is available with id 'cloud_script_api'.

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": {
      "id": "<id>"
    },
    "name": "get_documentation"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesDocument id from search_documentation results

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already cover the safe-read profile (readOnlyHint, destructiveHint=false, openWorldHint=false), so the description adds value by disclosing what comes back — title, URL, source and plain-text body — plus the caveat that some user-guide articles embed screenshots as Markdown images, which affects downstream parsing. It does not mention size limits or truncation for long documents.

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?

Four sentences, front-loaded with purpose and id provenance, then return shape, then two practical hints. Each sentence carries distinct information with no repetition of the schema.

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?

For a single-parameter read tool with no output schema, the description covers input provenance, id format, returned fields and a content caveat — everything an agent needs to call it and interpret the result correctly.

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 schema already explains 'id', but the description adds real meaning beyond it: the provenance of the id, two concrete format examples ('user_guide:360038959391', 'legal:terms'), and one known special id ('cloud_script_api'). That is more than the schema alone conveys.

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?

Opens with a specific verb and resource ('Retrieve the full text of a specific documentation entry') and immediately ties it to the search-then-fetch workflow, which separates it from search_documentation. The stated return fields (title, URL, source, body) make the output shape unambiguous.

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?

Explicitly says the id comes from search_documentation results and gives concrete id formats, so an agent knows it must search first. It does not state a when-not condition (e.g. not for API method schemas), so it stops short of full alternative routing.

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