Skip to main content
Glama

Claude Platform Docs

Read docs page

get_doc
Read-onlyIdempotent

Get the full content of a documentation page. Returns the page title, description, URL, and cleaned markdown content.

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": {
      "path": "<path>"
    },
    "name": "get_doc"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYesDocumentation path (e.g., /docs/en/intro or intro) or a result URL from search_docs (e.g., https://platform.claude.com/docs/en/intro). For fuzzy lookup, use search_docs.
sdk_languagesNoOnly include code examples in these languages. Without it, pages include the examples in every language and are much longer.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/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 genuine value by disclosing the return shape (title, description, URL, cleaned markdown content), which no output schema provides.

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 sentences, zero waste, with the core action front-loaded and the return contents following it. Nothing could be removed without losing information.

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 two-parameter read tool with full annotation and schema coverage, the description covers purpose and return values. Minor gaps remain around error behavior for an invalid path and how large the returned content can be.

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 description coverage is 100%, and the path and sdk_languages parameters are thoroughly documented in the schema, including the size tradeoff for omitting languages. The description adds nothing about parameters, so the baseline of 3 applies.

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 verb and resource ('Get the full content of a documentation page') and clarifies the scope is the entire page. It does not name or differentiate itself from siblings like get_navigation or search_docs; that routing lives only in the schema text.

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?

Usage is only implied: 'full content' suggests fetching a known page, while fuzzy lookup lives in the path parameter description pointing to search_docs. The description itself gives no when-to-use or when-not-to-use guidance.

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