Skip to main content
Glama

Read a Twinr doc

read_twinr_doc
Read-onlyIdempotent

Read one Twinr help page by the path search_twinr_docs returned, e.g. builds/android.md.

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": "read_twinr_doc"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYesA page path from search_twinr_docs, e.g. builds/android.md.

Output Schema

NameRequiredDescriptionDefault
urlYes
pathYes
titleYes
contentYes
sectionYes
descriptionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/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 behavior, so safety is covered structurally. The description adds the provenance constraint on the path but says nothing about failure modes such as a stale or unknown path, or about page size/return shape.

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?

One front-loaded sentence with an inline example and zero filler. Every clause carries information: action, scope, identifier source, and format sample.

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?

With one required parameter, full schema coverage, an output schema, and complete annotations, the definition covers what an agent needs to invoke it correctly. Only minor gaps remain around invalid-path handling.

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 documents the single path parameter with format, length bounds, and an example. The description restates the same example (builds/android.md) without adding new meaning, so baseline 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 concrete verb and resource ("Read one Twinr help page") plus the exact identifier form ("path search_twinr_docs returned"). It implicitly contrasts with the search sibling by consuming its output rather than querying, though it never explicitly names the alternative in prose.

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?

Gives clear context: this is the follow-up step to search_twinr_docs, and the path must originate from those results. No explicit exclusions or guidance on when a different retrieval tool is preferable, so it stops 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