Skip to main content
Glama

Terudo developer docs

Read a Terudo docs page

read_doc
Read-onlyIdempotent

The full Markdown of one documentation page, or one section with #anchor. Pages: index, quickstart, elements, integrate-in-your-flow, api, api-reference, webhooks, testing, ai-tools, cli. A URL from search_docs works too.

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
pageYesPage slug ("elements"), "elements#sessions", or a URL from search_docs.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior3/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 the useful facts that output is raw Markdown and that an #anchor narrows the result to a single section. It says nothing about behavior on an unknown page slug or the size of the returned payload, which is the remaining gap for a 3+ score.

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?

Three short sentences: the return contract first, then the accepted values, then the URL input case. No filler, and the most important information (what you get back) is front-loaded.

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-parameter read tool with full schema coverage and no output schema, the description covers input forms and return format adequately. Only edge-case behavior (invalid slugs, truncation of very long pages) is unaddressed.

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's own example already demonstrates the "elements#sessions" anchor form, so most of the parameter semantics are pre-supplied. The description contributes the accepted slug vocabulary and confirms URL passthrough, which is marginal but real added meaning over the schema.

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?

States a specific resource (one documentation page) and exactly what is returned (the full Markdown, or a single section when an #anchor is given). The enumeration of pages plus the note that a search_docs URL is also valid makes it clearly distinguishable from the search/list siblings.

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 implicitly routes the agent: use search_docs to find a page, then pass either the slug or the resulting URL here. It gives no explicit when-not-to-use guidance or contrast with list_docs/api_reference, so it falls short of a 5.

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