Skip to main content
Glama

Read a doc page

read_docs
Read-onlyIdempotent

Read one approved API reference, editing/meme/trend reference card or guide by an id from search_docs, or by a node or symbol name such as Video, Img, Txt. Includes signatures, argument order, layout/text behavior, deterministic animation and SkSL shader contracts. Also reads a skill a tool names by its id, such as builtin-film-tracks. No implementation source, arbitrary files or URLs. Unknown ids fail.

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>",
      "projectId": "<projectId>"
    },
    "name": "read_docs"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesAn id from search_docs, a skill such as builtin-film-tracks, or a node or symbol name such as Video, Img, Txt, clamp, or a guide name such as video-in-components. Not a path or URL.
projectIdYesThe project this call runs on without changing the open project. null (or leaving it out) uses the open project. wait_for_jobs takes the projectId of the calls that started the jobs.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / id / description
      Previous value: -"An id from search_docs, a skill of the skills directory such as skills/family-edit (skills lists them), or a node or symbol name such as Video, Img, Txt, clamp, or a guide name such as video-in-components. Not a path or URL."New value: +"An id from search_docs, a skill such as builtin-film-tracks, or a node or symbol name such as Video, Img, Txt, clamp, or a guide name such as video-in-components. Not a path or URL."
  2. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, and closed-world, so the safety profile is covered. The description adds real value beyond that: the content payload (signatures, argument order, layout/text behavior, animation and SkSL shader contracts) and error behavior ("Unknown ids fail"), which annotations cannot express.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the verb and resource, and every clause carries information (scope, payload, exclusions, failure mode). Slightly dense in the middle with the "editing/meme/trend reference card" enumeration, but nothing is 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 two-parameter read tool with full schema coverage and strong annotations, this is close to complete: it says what the document contains, what it will not fetch, and that unknown ids error out. Return shape (pages, sections, truncation) is not described, which is a minor gap given there is no output schema.

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 schema already explains that id may be a search_docs id, skill name, node/symbol name, or guide name, and that projectId null means the open project. The description reinforces these but adds little syntax or format detail beyond the schema; the only marginal addition is that a tool can name a skill id such as builtin-film-tracks.

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?

"Read one approved API reference, editing/meme/trend reference card or guide" names a specific verb and resource, and the id-from-search_docs / node-or-symbol-name framing lets an agent distinguish this from read_asset, read_element, or list_files without opening the schema.

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?

It routes the agent from search_docs into read_docs and states the boundary of what can be fetched ("No implementation source, arbitrary files or URLs"), plus a distinct sub-case (reading a skill a tool names by its id). No explicit statement of when to prefer a sibling like read_asset, but the scope boundary is clear enough to make the choice.

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.