Skip to main content
Glama

Read a docs page

read_doc
Read-only

Fetches a Casama documentation page as markdown from a file path or URL, optionally returning just one heading section. Use it to look up guides, API references, and plugin docs.

Instructions

One docs page as markdown, by path or address: "/develop/plugins", "develop/api.md" or "https://docs.casama.ai/guide/skills". Pass section to get one ## section only.

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": {
      "page": "<page>"
    },
    "name": "read_doc"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageYes
sectionNoA ## heading on the page, e.g. "Secrets"

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.7/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety is covered. The description adds genuinely new behavior: the response is markdown, full URLs are accepted, and passing section returns only one ## section. It does not say what happens on a nonexistent path, an ambiguous section, or a URL outside the docs host, which is the remaining gap for a fetch tool.

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, front-loaded with the return type and input modes, examples embedded inline rather than in a separate list, and the optional narrowing behavior last. 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 2-parameter read tool with no output schema and safety covered by annotations, the description covers input addressing, output format and section scoping. Missing only edge-case behavior (invalid path, unmatched section) and a nudge toward search_docs when the path is unknown.

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 50% and the undescribed parameter is page, which the description rescues with three format examples ("develop/api.md", "/develop/plugins", full URL) plus the max-length implication of paths. The section parameter is already documented in the schema and the description adds its effect (one ## section only), though exact-match or case sensitivity is unstated.

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?

Specific verb and resource: "One docs page as markdown, by path or address", followed by three concrete addressing examples. This clearly separates it from a search or listing tool, though no sibling tool is named explicitly to sharpen the boundary.

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 implied through the accepted input forms (relative path, .md path, absolute docs URL) and the optional section narrowing, which tells the agent this is a direct-fetch tool rather than a search. There is no explicit when-to-use/when-not guidance and no pointer to search_docs or list_doc_pages for cases where the path is unknown.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.